home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2007 December / PCWKCD1207B.iso / Blogowanie poza sfera / Flock 1.0 beta / flock-1.0RC3.en-US.win32.exe / flock / components / nsSearchService.js < prev    next >
Text File  |  2007-10-18  |  107KB  |  3,097 lines
  1. //@line 40 "/cygdrive/K/tinderbuild/src/flock/mozilla/browser/components/search/nsSearchService.js"
  2.  
  3. const Ci = Components.interfaces;
  4. const Cc = Components.classes;
  5. const Cr = Components.results;
  6.  
  7. const PERMS_FILE      = 0644;
  8. const PERMS_DIRECTORY = 0755;
  9.  
  10. const MODE_RDONLY   = 0x01;
  11. const MODE_WRONLY   = 0x02;
  12. const MODE_CREATE   = 0x08;
  13. const MODE_APPEND   = 0x10;
  14. const MODE_TRUNCATE = 0x20;
  15.  
  16. // Directory service keys
  17. const NS_APP_SEARCH_DIR_LIST  = "SrchPluginsDL";
  18. const NS_APP_USER_SEARCH_DIR  = "UsrSrchPlugns";
  19. const NS_APP_SEARCH_DIR       = "SrchPlugns";
  20. const NS_APP_USER_PROFILE_50_DIR = "ProfD";
  21.  
  22. // See documentation in nsIBrowserSearchService.idl.
  23. const SEARCH_ENGINE_TOPIC        = "browser-search-engine-modified";
  24. const QUIT_APPLICATION_TOPIC     = "quit-application";
  25.  
  26. const SEARCH_ENGINE_REMOVED      = "engine-removed";
  27. const SEARCH_ENGINE_ADDED        = "engine-added";
  28. const SEARCH_ENGINE_CHANGED      = "engine-changed";
  29. const SEARCH_ENGINE_LOADED       = "engine-loaded";
  30. const SEARCH_ENGINE_CURRENT      = "engine-current";
  31.  
  32. const SEARCH_TYPE_MOZSEARCH      = Ci.nsISearchEngine.TYPE_MOZSEARCH;
  33. const SEARCH_TYPE_OPENSEARCH     = Ci.nsISearchEngine.TYPE_OPENSEARCH;
  34. const SEARCH_TYPE_SHERLOCK       = Ci.nsISearchEngine.TYPE_SHERLOCK;
  35.  
  36. const SEARCH_DATA_XML            = Ci.nsISearchEngine.DATA_XML;
  37. const SEARCH_DATA_TEXT           = Ci.nsISearchEngine.DATA_TEXT;
  38.  
  39. // File extensions for search plugin description files
  40. const XML_FILE_EXT      = "xml";
  41. const SHERLOCK_FILE_EXT = "src";
  42.  
  43. const ICON_DATAURL_PREFIX = "data:image/x-icon;base64,";
  44.  
  45. // Supported extensions for Sherlock plugin icons
  46. const SHERLOCK_ICON_EXTENSIONS = [".gif", ".png", ".jpg", ".jpeg"];
  47.  
  48. const NEW_LINES = /(\r\n|\r|\n)/;
  49.  
  50. // Set an arbitrary cap on the maximum icon size. Without this, large icons can
  51. // cause big delays when loading them at startup.
  52. const MAX_ICON_SIZE   = 10000;
  53.  
  54. // Default charset to use for sending search parameters. ISO-8859-1 is used to
  55. // match previous nsInternetSearchService behavior.
  56. const DEFAULT_QUERY_CHARSET = "ISO-8859-1";
  57.  
  58. const SEARCH_BUNDLE = "chrome://browser/locale/search.properties";
  59. const SIDEBAR_BUNDLE = "chrome://browser/locale/sidebar/sidebar.properties";
  60. const BRAND_BUNDLE = "chrome://branding/locale/brand.properties";
  61.  
  62. const OPENSEARCH_NS_10  = "http://a9.com/-/spec/opensearch/1.0/";
  63. const OPENSEARCH_NS_11  = "http://a9.com/-/spec/opensearch/1.1/";
  64.  
  65. // Although the specification at http://opensearch.a9.com/spec/1.1/description/
  66. // gives the namespace names defined above, many existing OpenSearch engines
  67. // are using the following versions.  We therefore allow either.
  68. const OPENSEARCH_NAMESPACES = [
  69.   OPENSEARCH_NS_11, OPENSEARCH_NS_10,
  70.   "http://a9.com/-/spec/opensearchdescription/1.1/",
  71.   "http://a9.com/-/spec/opensearchdescription/1.0/"
  72. ];
  73.  
  74. const OPENSEARCH_LOCALNAME = "OpenSearchDescription";
  75.  
  76. const MOZSEARCH_NS_10     = "http://www.mozilla.org/2006/browser/search/";
  77. const MOZSEARCH_LOCALNAME = "SearchPlugin";
  78.  
  79. const URLTYPE_SUGGEST_JSON = "application/x-suggestions+json";
  80. const URLTYPE_SEARCH_HTML  = "text/html";
  81.  
  82. // Empty base document used to serialize engines to file.
  83. const EMPTY_DOC = "<?xml version=\"1.0\"?>\n" +
  84.                   "<" + MOZSEARCH_LOCALNAME +
  85.                   " xmlns=\"" + MOZSEARCH_NS_10 + "\"" +
  86.                   " xmlns:os=\"" + OPENSEARCH_NS_11 + "\"" +
  87.                   "/>";
  88.  
  89. const BROWSER_SEARCH_PREF = "browser.search.";
  90.  
  91. const USER_DEFINED = "{searchTerms}";
  92.  
  93. // Custom search parameters
  94. //@line 133 "/cygdrive/K/tinderbuild/src/flock/mozilla/browser/components/search/nsSearchService.js"
  95. const MOZ_OFFICIAL = "official";
  96. const MOZ_DISTRIBUTION_ID = "FlockInc.";
  97. //@line 138 "/cygdrive/K/tinderbuild/src/flock/mozilla/browser/components/search/nsSearchService.js"
  98.  
  99. const MOZ_PARAM_LOCALE         = /\{moz:locale\}/g;
  100. const MOZ_PARAM_DIST_ID        = /\{moz:distributionID\}/g;
  101. const MOZ_PARAM_OFFICIAL       = /\{moz:official\}/g;
  102.  
  103. // Supported OpenSearch parameters
  104. // See http://opensearch.a9.com/spec/1.1/querysyntax/#core
  105. const OS_PARAM_USER_DEFINED    = /\{searchTerms\??\}/g;
  106. const OS_PARAM_INPUT_ENCODING  = /\{inputEncoding\??\}/g;
  107. const OS_PARAM_LANGUAGE        = /\{language\??\}/g;
  108. const OS_PARAM_OUTPUT_ENCODING = /\{outputEncoding\??\}/g;
  109.  
  110. // Default values
  111. const OS_PARAM_LANGUAGE_DEF         = "*";
  112. const OS_PARAM_OUTPUT_ENCODING_DEF  = "UTF-8";
  113. const OS_PARAM_INPUT_ENCODING_DEF   = "UTF-8";
  114.  
  115. // "Unsupported" OpenSearch parameters. For example, we don't support
  116. // page-based results, so if the engine requires that we send the "page index"
  117. // parameter, we'll always send "1".
  118. const OS_PARAM_COUNT        = /\{count\??\}/g;
  119. const OS_PARAM_START_INDEX  = /\{startIndex\??\}/g;
  120. const OS_PARAM_START_PAGE   = /\{startPage\??\}/g;
  121.  
  122. // Default values
  123. const OS_PARAM_COUNT_DEF        = "20"; // 20 results
  124. const OS_PARAM_START_INDEX_DEF  = "1";  // start at 1st result
  125. const OS_PARAM_START_PAGE_DEF   = "1";  // 1st page
  126.  
  127. // Optional parameter
  128. const OS_PARAM_OPTIONAL     = /\{\w+\?\}/g;
  129.  
  130. // A array of arrays containing parameters that we don't fully support, and
  131. // their default values. We will only send values for these parameters if
  132. // required, since our values are just really arbitrary "guesses" that should
  133. // give us the output we want.
  134. var OS_UNSUPPORTED_PARAMS = [
  135.   [OS_PARAM_COUNT, OS_PARAM_COUNT_DEF],
  136.   [OS_PARAM_START_INDEX, OS_PARAM_START_INDEX_DEF],
  137.   [OS_PARAM_START_PAGE, OS_PARAM_START_PAGE_DEF],
  138. ];
  139.  
  140. // The default engine update interval, in days. This is only used if an engine
  141. // specifies an updateURL, but not an updateInterval.
  142. const SEARCH_DEFAULT_UPDATE_INTERVAL = 7;
  143.  
  144. // Returns false for whitespace-only or commented out lines in a
  145. // Sherlock file, true otherwise.
  146. function isUsefulLine(aLine) {
  147.   return !(/^\s*($|#)/i.test(aLine));
  148. }
  149.  
  150. /**
  151.  * Prefixed to all search debug output.
  152.  */
  153. const SEARCH_LOG_PREFIX = "*** Search: ";
  154.  
  155. /**
  156.  * Outputs aText to the JavaScript console as well as to stdout, if the search
  157.  * logging pref (browser.search.log) is set to true.
  158.  */
  159. function LOG(aText) {
  160.   var prefB = Cc["@mozilla.org/preferences-service;1"].
  161.               getService(Ci.nsIPrefBranch);
  162.   var shouldLog = false;
  163.   try {
  164.     shouldLog = prefB.getBoolPref(BROWSER_SEARCH_PREF + "log");
  165.   } catch (ex) {}
  166.  
  167.   if (shouldLog) {
  168.     dump(SEARCH_LOG_PREFIX + aText + "\n");
  169.     var consoleService = Cc["@mozilla.org/consoleservice;1"].
  170.                          getService(Ci.nsIConsoleService);
  171.     consoleService.logStringMessage(aText);
  172.   }
  173. }
  174.  
  175. function ERROR(message, resultCode) {
  176.   NS_ASSERT(false, SEARCH_LOG_PREFIX + message);
  177.   throw resultCode;
  178. }
  179.  
  180. /**
  181.  * Ensures an assertion is met before continuing. Should be used to indicate
  182.  * fatal errors.
  183.  * @param  assertion
  184.  *         An assertion that must be met
  185.  * @param  message
  186.  *         A message to display if the assertion is not met
  187.  * @param  resultCode
  188.  *         The NS_ERROR_* value to throw if the assertion is not met
  189.  * @throws resultCode
  190.  */
  191. function ENSURE_WARN(assertion, message, resultCode) {
  192.   NS_ASSERT(assertion, SEARCH_LOG_PREFIX + message);
  193.   if (!assertion)
  194.     throw resultCode;
  195. }
  196.  
  197. /**
  198.  * Ensures an assertion is met before continuing, but does not warn the user.
  199.  * Used to handle normal failure conditions.
  200.  * @param  assertion
  201.  *         An assertion that must be met
  202.  * @param  message
  203.  *         A message to display if the assertion is not met
  204.  * @param  resultCode
  205.  *         The NS_ERROR_* value to throw if the assertion is not met
  206.  * @throws resultCode
  207.  */
  208. function ENSURE(assertion, message, resultCode) {
  209.   if (!assertion) {
  210.     LOG(message);
  211.     throw resultCode;
  212.   }
  213. }
  214.  
  215. /**
  216.  * Ensures an argument assertion is met before continuing.
  217.  * @param  assertion
  218.  *         An argument assertion that must be met
  219.  * @param  message
  220.  *         A message to display if the assertion is not met
  221.  * @throws NS_ERROR_INVALID_ARG for invalid arguments
  222.  */
  223. function ENSURE_ARG(assertion, message) {
  224.   ENSURE(assertion, message, Cr.NS_ERROR_INVALID_ARG);
  225. }
  226.  
  227. // FIXME: Bug 326854: no btoa for components, use our own
  228. /**
  229.  * Encodes an array of bytes into a string using the base 64 encoding scheme.
  230.  * @param aBytes
  231.  *        An array of bytes to encode.
  232.  */
  233. function b64(aBytes) {
  234.   const B64_CHARS =
  235.             "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  236.   var out = "", bits, i, j;
  237.  
  238.   while (aBytes.length >= 3) {
  239.     bits = 0;
  240.     for (i = 0; i < 3; i++) {
  241.       bits <<= 8;
  242.       bits |= aBytes[i];
  243.     }
  244.     for (j = 18; j >= 0; j -= 6)
  245.       out += B64_CHARS[(bits>>j) & 0x3F];
  246.  
  247.     aBytes.splice(0, 3);
  248.   }
  249.  
  250.   switch (aBytes.length) {
  251.     case 2:
  252.       out += B64_CHARS[(aBytes[0]>>2) & 0x3F];
  253.       out += B64_CHARS[((aBytes[0] & 0x03) << 4) | ((aBytes[1] >> 4) & 0x0F)];
  254.       out += B64_CHARS[((aBytes[1] & 0x0F) << 2)];
  255.       out += "=";
  256.       break;
  257.     case 1:
  258.       out += B64_CHARS[(aBytes[0]>>2) & 0x3F];
  259.       out += B64_CHARS[(aBytes[0] & 0x03) << 4];
  260.       out += "==";
  261.       break;
  262.   }
  263.   return out;
  264. }
  265.  
  266. function loadListener(aChannel, aEngine, aCallback) {
  267.   this._channel = aChannel;
  268.   this._bytes = [];
  269.   this._engine = aEngine;
  270.   this._callback = aCallback;
  271. }
  272. loadListener.prototype = {
  273.   _callback: null,
  274.   _channel: null,
  275.   _countRead: 0,
  276.   _engine: null,
  277.   _stream: null,
  278.  
  279.   QueryInterface: function SRCH_loadQI(aIID) {
  280.     if (aIID.equals(Ci.nsISupports)           ||
  281.         aIID.equals(Ci.nsIRequestObserver)    ||
  282.         aIID.equals(Ci.nsIStreamListener)     ||
  283.         aIID.equals(Ci.nsIChannelEventSink)   ||
  284.         aIID.equals(Ci.nsIInterfaceRequestor) ||
  285.         aIID.equals(Ci.nsIBadCertListener)    ||
  286.         // See FIXME comment below
  287.         aIID.equals(Ci.nsIHttpEventSink)      ||
  288.         aIID.equals(Ci.nsIProgressEventSink)  ||
  289.         false)
  290.       return this;
  291.  
  292.     throw Cr.NS_ERROR_NO_INTERFACE;
  293.   },
  294.  
  295.   // nsIRequestObserver
  296.   onStartRequest: function SRCH_loadStartR(aRequest, aContext) {
  297.     LOG("loadListener: Starting request: " + aRequest.name);
  298.     this._stream = Cc["@mozilla.org/binaryinputstream;1"].
  299.                    createInstance(Ci.nsIBinaryInputStream);
  300.   },
  301.  
  302.   onStopRequest: function SRCH_loadStopR(aRequest, aContext, aStatusCode) {
  303.     LOG("loadListener: Stopping request: " + aRequest.name);
  304.  
  305.     var requestFailed = !Components.isSuccessCode(aStatusCode);
  306.     if (!requestFailed && (aRequest instanceof Ci.nsIHttpChannel))
  307.       requestFailed = !aRequest.requestSucceeded;
  308.  
  309.     if (requestFailed || this._countRead == 0) {
  310.       LOG("loadListener: request failed!");
  311.       // send null so the callback can deal with the failure
  312.       this._callback(null, this._engine);
  313.     } else
  314.       this._callback(this._bytes, this._engine);
  315.     this._channel = null;
  316.     this._engine  = null;
  317.   },
  318.  
  319.   // nsIStreamListener
  320.   onDataAvailable: function SRCH_loadDAvailable(aRequest, aContext,
  321.                                                 aInputStream, aOffset,
  322.                                                 aCount) {
  323.     this._stream.setInputStream(aInputStream);
  324.  
  325.     // Get a byte array of the data
  326.     this._bytes = this._bytes.concat(this._stream.readByteArray(aCount));
  327.     this._countRead += aCount;
  328.   },
  329.  
  330.   // nsIChannelEventSink
  331.   onChannelRedirect: function SRCH_loadCRedirect(aOldChannel, aNewChannel,
  332.                                                  aFlags) {
  333.     this._channel = aNewChannel;
  334.   },
  335.  
  336.   // nsIInterfaceRequestor
  337.   getInterface: function SRCH_load_GI(aIID) {
  338.     return this.QueryInterface(aIID);
  339.   },
  340.  
  341.   // nsIBadCertListener
  342.   confirmUnknownIssuer: function SRCH_load_CUI(aSocketInfo, aCert,
  343.                                                aCertAddType) {
  344.     return false;
  345.   },
  346.  
  347.   confirmMismatchDomain: function SRCH_load_CMD(aSocketInfo, aTargetURL,
  348.                                                 aCert) {
  349.     return false;
  350.   },
  351.  
  352.   confirmCertExpired: function SRCH_load_CCE(aSocketInfo, aCert) {
  353.     return false;
  354.   },
  355.  
  356.   notifyCrlNextupdate: function SRCH_load_NCN(aSocketInfo, aTargetURL, aCert) {
  357.   },
  358.  
  359.   // FIXME: bug 253127
  360.   // nsIHttpEventSink
  361.   onRedirect: function (aChannel, aNewChannel) {},
  362.   // nsIProgressEventSink
  363.   onProgress: function (aRequest, aContext, aProgress, aProgressMax) {},
  364.   onStatus: function (aRequest, aContext, aStatus, aStatusArg) {}
  365. }
  366.  
  367.  
  368. /**
  369.  * Used to verify a given DOM node's localName and namespaceURI.
  370.  * @param aElement
  371.  *        The element to verify.
  372.  * @param aLocalNameArray
  373.  *        An array of strings to compare against aElement's localName.
  374.  * @param aNameSpaceArray
  375.  *        An array of strings to compare against aElement's namespaceURI.
  376.  *
  377.  * @returns false if aElement is null, or if its localName or namespaceURI
  378.  *          does not match one of the elements in the aLocalNameArray or
  379.  *          aNameSpaceArray arrays, respectively.
  380.  * @throws NS_ERROR_INVALID_ARG if aLocalNameArray or aNameSpaceArray are null.
  381.  */
  382. function checkNameSpace(aElement, aLocalNameArray, aNameSpaceArray) {
  383.   ENSURE_ARG(aLocalNameArray && aNameSpaceArray, "missing aLocalNameArray or \
  384.              aNameSpaceArray for checkNameSpace");
  385.   return (aElement                                                &&
  386.           (aLocalNameArray.indexOf(aElement.localName)    != -1)  &&
  387.           (aNameSpaceArray.indexOf(aElement.namespaceURI) != -1));
  388. }
  389.  
  390. /**
  391.  * Safely close a nsISafeOutputStream.
  392.  * @param aFOS
  393.  *        The file output stream to close.
  394.  */
  395. function closeSafeOutputStream(aFOS) {
  396.   if (aFOS instanceof Ci.nsISafeOutputStream) {
  397.     try {
  398.       aFOS.finish();
  399.       return;
  400.     } catch (e) { }
  401.   }
  402.   aFOS.close();
  403. }
  404.  
  405. /**
  406.  * Wrapper function for nsIIOService::newURI.
  407.  * @param aURLSpec
  408.  *        The URL string from which to create an nsIURI.
  409.  * @returns an nsIURI object, or null if the creation of the URI failed.
  410.  */
  411. function makeURI(aURLSpec, aCharset) {
  412.   var ios = Cc["@mozilla.org/network/io-service;1"].
  413.             getService(Ci.nsIIOService);
  414.   try {
  415.     return ios.newURI(aURLSpec, aCharset, null);
  416.   } catch (ex) { }
  417.  
  418.   return null;
  419. }
  420.  
  421. /**
  422.  * Gets a directory from the directory service.
  423.  * @param aKey
  424.  *        The directory service key indicating the directory to get.
  425.  */
  426. function getDir(aKey) {
  427.   ENSURE_ARG(aKey, "getDir requires a directory key!");
  428.  
  429.   var fileLocator = Cc["@mozilla.org/file/directory_service;1"].
  430.                     getService(Ci.nsIProperties);
  431.   var dir = fileLocator.get(aKey, Ci.nsIFile);
  432.   return dir;
  433. }
  434.  
  435. /**
  436.  * The following two functions are essentially copied from
  437.  * nsInternetSearchService. They are required for backwards compatibility.
  438.  */
  439. function queryCharsetFromCode(aCode) {
  440.   const codes = [];
  441.   codes[0] = "x-mac-roman";
  442.   codes[6] = "x-mac-greek";
  443.   codes[35] = "x-mac-turkish";
  444.   codes[513] = "ISO-8859-1";
  445.   codes[514] = "ISO-8859-2";
  446.   codes[517] = "ISO-8859-5";
  447.   codes[518] = "ISO-8859-6";
  448.   codes[519] = "ISO-8859-7";
  449.   codes[520] = "ISO-8859-8";
  450.   codes[521] = "ISO-8859-9";
  451.   codes[1049] = "IBM864";
  452.   codes[1280] = "windows-1252";
  453.   codes[1281] = "windows-1250";
  454.   codes[1282] = "windows-1251";
  455.   codes[1283] = "windows-1253";
  456.   codes[1284] = "windows-1254";
  457.   codes[1285] = "windows-1255";
  458.   codes[1286] = "windows-1256";
  459.   codes[1536] = "us-ascii";
  460.   codes[1584] = "GB2312";
  461.   codes[1585] = "x-gbk";
  462.   codes[1600] = "EUC-KR";
  463.   codes[2080] = "ISO-2022-JP";
  464.   codes[2096] = "ISO-2022-CN";
  465.   codes[2112] = "ISO-2022-KR";
  466.   codes[2336] = "EUC-JP";
  467.   codes[2352] = "GB2312";
  468.   codes[2353] = "x-euc-tw";
  469.   codes[2368] = "EUC-KR";
  470.   codes[2561] = "Shift_JIS";
  471.   codes[2562] = "KOI8-R";
  472.   codes[2563] = "Big5";
  473.   codes[2565] = "HZ-GB-2312";
  474.  
  475.   if (codes[aCode])
  476.     return codes[aCode];
  477.  
  478.   return getLocalizedPref("intl.charset.default", DEFAULT_QUERY_CHARSET);
  479. }
  480. function fileCharsetFromCode(aCode) {
  481.   const codes = [
  482.     "x-mac-roman",           // 0
  483.     "Shift_JIS",             // 1
  484.     "Big5",                  // 2
  485.     "EUC-KR",                // 3
  486.     "X-MAC-ARABIC",          // 4
  487.     "X-MAC-HEBREW",          // 5
  488.     "X-MAC-GREEK",           // 6
  489.     "X-MAC-CYRILLIC",        // 7
  490.     "X-MAC-DEVANAGARI" ,     // 9
  491.     "X-MAC-GURMUKHI",        // 10
  492.     "X-MAC-GUJARATI",        // 11
  493.     "X-MAC-ORIYA",           // 12
  494.     "X-MAC-BENGALI",         // 13
  495.     "X-MAC-TAMIL",           // 14
  496.     "X-MAC-TELUGU",          // 15
  497.     "X-MAC-KANNADA",         // 16
  498.     "X-MAC-MALAYALAM",       // 17
  499.     "X-MAC-SINHALESE",       // 18
  500.     "X-MAC-BURMESE",         // 19
  501.     "X-MAC-KHMER",           // 20
  502.     "X-MAC-THAI",            // 21
  503.     "X-MAC-LAOTIAN",         // 22
  504.     "X-MAC-GEORGIAN",        // 23
  505.     "X-MAC-ARMENIAN",        // 24
  506.     "GB2312",                // 25
  507.     "X-MAC-TIBETAN",         // 26
  508.     "X-MAC-MONGOLIAN",       // 27
  509.     "X-MAC-ETHIOPIC",        // 28
  510.     "X-MAC-CENTRALEURROMAN", // 29
  511.     "X-MAC-VIETNAMESE",      // 30
  512.     "X-MAC-EXTARABIC"        // 31
  513.   ];
  514.   // Sherlock files have always defaulted to x-mac-roman, so do that here too
  515.   return codes[aCode] || codes[0];
  516. }
  517.  
  518. /**
  519.  * Returns a string interpretation of aBytes using aCharset, or null on
  520.  * failure.
  521.  */
  522. function bytesToString(aBytes, aCharset) {
  523.   var converter = Cc["@mozilla.org/intl/scriptableunicodeconverter"].
  524.                   createInstance(Ci.nsIScriptableUnicodeConverter);
  525.   LOG("bytesToString: converting using charset: " + aCharset);
  526.  
  527.   try {
  528.     converter.charset = aCharset;
  529.     return converter.convertFromByteArray(aBytes, aBytes.length);
  530.   } catch (ex) {}
  531.  
  532.   return null;
  533. }
  534.  
  535. /**
  536.  * Converts an array of bytes representing a Sherlock file into an array of
  537.  * lines representing the useful data from the file.
  538.  *
  539.  * @param aBytes
  540.  *        The array of bytes representing the Sherlock file.
  541.  * @param aCharsetCode
  542.  *        An integer value representing a character set code to be passed to
  543.  *        fileCharsetFromCode, or null for the default Sherlock encoding.
  544.  */
  545. function sherlockBytesToLines(aBytes, aCharsetCode) {
  546.   // fileCharsetFromCode returns the default encoding if aCharsetCode is null
  547.   var charset = fileCharsetFromCode(aCharsetCode);
  548.  
  549.   var dataString = bytesToString(aBytes, charset);
  550.   ENSURE(dataString, "sherlockBytesToLines: Couldn't convert byte array!",
  551.          Cr.NS_ERROR_FAILURE);
  552.  
  553.   // Split the string into lines, and filter out comments and
  554.   // whitespace-only lines
  555.   return dataString.split(NEW_LINES).filter(isUsefulLine);
  556. }
  557.  
  558. /**
  559.  * Gets the current value of the locale.  It's possible for this preference to
  560.  * be localized, so we have to do a little extra work here.  Similar code
  561.  * exists in nsHttpHandler.cpp when building the UA string.
  562.  */
  563. function getLocale() {
  564.   const localePref = "general.useragent.locale";
  565.   var locale = getLocalizedPref(localePref);
  566.   if (locale)
  567.     return locale;
  568.  
  569.   // Not localized
  570.   var prefs = Cc["@mozilla.org/preferences-service;1"].
  571.               getService(Ci.nsIPrefBranch);
  572.   return prefs.getCharPref(localePref);
  573. }
  574.  
  575. /**
  576.  * Wrapper for nsIPrefBranch::getComplexValue.
  577.  * @param aPrefName
  578.  *        The name of the pref to get.
  579.  * @returns aDefault if the requested pref doesn't exist.
  580.  */
  581. function getLocalizedPref(aPrefName, aDefault) {
  582.   var prefB = Cc["@mozilla.org/preferences-service;1"].
  583.               getService(Ci.nsIPrefBranch);
  584.   const nsIPLS = Ci.nsIPrefLocalizedString;
  585.   try {
  586.     return prefB.getComplexValue(aPrefName, nsIPLS).data;
  587.   } catch (ex) {}
  588.  
  589.   return aDefault;
  590. }
  591.  
  592. /**
  593.  * Wrapper for nsIPrefBranch::setComplexValue.
  594.  * @param aPrefName
  595.  *        The name of the pref to set.
  596.  */
  597. function setLocalizedPref(aPrefName, aValue) {
  598.   var prefB = Cc["@mozilla.org/preferences-service;1"].
  599.               getService(Ci.nsIPrefBranch);
  600.   const nsIPLS = Ci.nsIPrefLocalizedString;
  601.   try {
  602.     var pls = Components.classes["@mozilla.org/pref-localizedstring;1"]
  603.                         .createInstance(Ci.nsIPrefLocalizedString);
  604.     pls.data = aValue;
  605.     prefB.setComplexValue(aPrefName, nsIPLS, pls);
  606.   } catch (ex) {}
  607. }
  608.  
  609. /**
  610.  * Wrapper for nsIPrefBranch::getBoolPref.
  611.  * @param aPrefName
  612.  *        The name of the pref to get.
  613.  * @returns aDefault if the requested pref doesn't exist.
  614.  */
  615. function getBoolPref(aName, aDefault) {
  616.   var prefB = Cc["@mozilla.org/preferences-service;1"].
  617.               getService(Ci.nsIPrefBranch);
  618.   try {
  619.     return prefB.getBoolPref(aName);
  620.   } catch (ex) {
  621.     return aDefault;
  622.   }
  623. }
  624.  
  625. /**
  626.  * Get a unique nsIFile object with a sanitized name, based on the engine name.
  627.  * @param aName
  628.  *        A name to "sanitize". Can be an empty string, in which case a random
  629.  *        8 character filename will be produced.
  630.  * @returns A nsIFile object in the user's search engines directory with a
  631.  *          unique sanitized name.
  632.  */
  633. function getSanitizedFile(aName) {
  634.   var fileName = sanitizeName(aName) + "." + XML_FILE_EXT;
  635.   var file = getDir(NS_APP_USER_SEARCH_DIR);
  636.   file.append(fileName);
  637.   file.createUnique(Ci.nsIFile.NORMAL_FILE_TYPE, PERMS_FILE);
  638.   return file;
  639. }
  640.  
  641. /**
  642.  * Removes all characters not in the "chars" string from aName.
  643.  *
  644.  * @returns a sanitized name to be used as a filename, or a random name
  645.  *          if a sanitized name cannot be obtained (if aName contains
  646.  *          no valid characters).
  647.  */
  648. function sanitizeName(aName) {
  649.   const chars = "-abcdefghijklmnopqrstuvwxyz0123456789";
  650.   const maxLength = 60;
  651.  
  652.   var name = aName.toLowerCase();
  653.   name = name.replace(/ /g, "-");
  654.   name = name.split("").filter(function (el) {
  655.                                  return chars.indexOf(el) != -1;
  656.                                }).join("");
  657.  
  658.   if (!name) {
  659.     // Our input had no valid characters - use a random name
  660.     var cl = chars.length - 1;
  661.     for (var i = 0; i < 8; ++i)
  662.       name += chars.charAt(Math.round(Math.random() * cl));
  663.   }
  664.  
  665.   if (name.length > maxLength)
  666.     name = name.substring(0, maxLength);
  667.  
  668.   return name;
  669. }
  670.  
  671. /**
  672.  * Notifies watchers of SEARCH_ENGINE_TOPIC about changes to an engine or to
  673.  * the state of the search service.
  674.  *
  675.  * @param aEngine
  676.  *        The nsISearchEngine object to which the change applies.
  677.  * @param aVerb
  678.  *        A verb describing the change.
  679.  *
  680.  * @see nsIBrowserSearchService.idl
  681.  */
  682. function notifyAction(aEngine, aVerb) {
  683.   var os = Cc["@mozilla.org/observer-service;1"].
  684.            getService(Ci.nsIObserverService);
  685.   LOG("NOTIFY: Engine: \"" + aEngine.name + "\"; Verb: \"" + aVerb + "\"");
  686.   os.notifyObservers(aEngine, SEARCH_ENGINE_TOPIC, aVerb);
  687. }
  688.  
  689. /**
  690.  * Simple object representing a name/value pair.
  691.  */
  692. function QueryParameter(aName, aValue) {
  693.   ENSURE_ARG(aName && (aValue != null),
  694.              "missing name or value for QueryParameter!");
  695.  
  696.   this.name = aName;
  697.   this.value = aValue;
  698. }
  699.  
  700. /**
  701.  * Perform OpenSearch parameter substitution on aParamValue.
  702.  *
  703.  * @param aParamValue
  704.  *        A string containing OpenSearch search parameters.
  705.  * @param aSearchTerms
  706.  *        The user-provided search terms. This string will inserted into
  707.  *        aParamValue as the value of the OS_PARAM_USER_DEFINED parameter.
  708.  *        This value must already be escaped appropriately - it is inserted
  709.  *        as-is.
  710.  * @param aQueryEncoding
  711.  *        The value to use for the OS_PARAM_INPUT_ENCODING parameter. See
  712.  *        definition in the OpenSearch spec.
  713.  *
  714.  * @see http://opensearch.a9.com/spec/1.1/querysyntax/#core
  715.  */
  716. function ParamSubstitution(aParamValue, aSearchTerms, aEngine) {
  717.   var value = aParamValue;
  718.  
  719.   var distributionID = MOZ_DISTRIBUTION_ID;
  720.   try {
  721.     var prefB = Cc["@mozilla.org/preferences-service;1"].
  722.                 getService(Ci.nsIPrefBranch);
  723.     distributionID = prefB.getCharPref(BROWSER_SEARCH_PREF + "distributionID");
  724.   }
  725.   catch (ex) { }
  726.  
  727.   // Custom search parameters. These are only available to app-shipped search
  728.   // engines.
  729.   if (aEngine._isInAppDir) {
  730.     value = value.replace(MOZ_PARAM_LOCALE, getLocale());
  731.     value = value.replace(MOZ_PARAM_DIST_ID, distributionID);
  732.     value = value.replace(MOZ_PARAM_OFFICIAL, MOZ_OFFICIAL);
  733.   }
  734.  
  735.   // Insert the OpenSearch parameters we're confident about
  736.   value = value.replace(OS_PARAM_USER_DEFINED, aSearchTerms);
  737.   value = value.replace(OS_PARAM_INPUT_ENCODING, aEngine.queryCharset);
  738.   value = value.replace(OS_PARAM_LANGUAGE,
  739.                         getLocale() || OS_PARAM_LANGUAGE_DEF);
  740.   value = value.replace(OS_PARAM_OUTPUT_ENCODING,
  741.                         OS_PARAM_OUTPUT_ENCODING_DEF);
  742.  
  743.   // Replace any optional parameters
  744.   value = value.replace(OS_PARAM_OPTIONAL, "");
  745.  
  746.   // Insert any remaining required params with our default values
  747.   for (var i = 0; i < OS_UNSUPPORTED_PARAMS.length; ++i) {
  748.     value = value.replace(OS_UNSUPPORTED_PARAMS[i][0],
  749.                           OS_UNSUPPORTED_PARAMS[i][1]);
  750.   }
  751.  
  752.   return value;
  753. }
  754.  
  755. /**
  756.  * Creates a mozStorage statement that can be used to access the database we
  757.  * use to hold metadata.
  758.  *
  759.  * @param dbconn  the database that the statement applies to
  760.  * @param sql     a string specifying the sql statement that should be created
  761.  */
  762. function createStatement (dbconn, sql) {
  763.   var stmt = dbconn.createStatement(sql);
  764.   var wrapper = Cc["@mozilla.org/storage/statement-wrapper;1"].
  765.                 createInstance(Ci.mozIStorageStatementWrapper);
  766.  
  767.   wrapper.initialize(stmt);
  768.   return wrapper;
  769. }
  770.  
  771. /**
  772.  * Creates an engineURL object, which holds the query URL and all parameters.
  773.  *
  774.  * @param aType
  775.  *        A string containing the name of the MIME type of the search results
  776.  *        returned by this URL.
  777.  * @param aMethod
  778.  *        The HTTP request method. Must be a case insensitive value of either
  779.  *        "GET" or "POST".
  780.  * @param aTemplate
  781.  *        The URL to which search queries should be sent. For GET requests,
  782.  *        must contain the string "{searchTerms}", to indicate where the user
  783.  *        entered search terms should be inserted.
  784.  *
  785.  * @see http://opensearch.a9.com/spec/1.1/querysyntax/#urltag
  786.  *
  787.  * @throws NS_ERROR_NOT_IMPLEMENTED if aType is unsupported.
  788.  */
  789. function EngineURL(aType, aMethod, aTemplate) {
  790.   ENSURE_ARG(aType && aMethod && aTemplate,
  791.              "missing type, method or template for EngineURL!");
  792.  
  793.   var method = aMethod.toUpperCase();
  794.   var type   = aType.toLowerCase();
  795.  
  796.   ENSURE_ARG(method == "GET" || method == "POST",
  797.              "method passed to EngineURL must be \"GET\" or \"POST\"");
  798.  
  799.   this.type     = type;
  800.   this.method   = method;
  801.   this.params   = [];
  802.  
  803.   var templateURI = makeURI(aTemplate);
  804.   ENSURE(templateURI, "new EngineURL: template is not a valid URI!",
  805.          Cr.NS_ERROR_FAILURE);
  806.  
  807.   switch (templateURI.scheme) {
  808.     case "http":
  809.     case "https":
  810.     // Disable these for now, see bug 295018
  811.     // case "file":
  812.     // case "resource":
  813.       this.template = aTemplate;
  814.       break;
  815.     default:
  816.       ENSURE(false, "new EngineURL: template uses invalid scheme!",
  817.              Cr.NS_ERROR_FAILURE);
  818.   }
  819. }
  820. EngineURL.prototype = {
  821.  
  822.   addParam: function SRCH_EURL_addParam(aName, aValue) {
  823.     this.params.push(new QueryParameter(aName, aValue));
  824.   },
  825.  
  826.   getSubmission: function SRCH_EURL_getSubmission(aSearchTerms, aEngine) {
  827.     var url = ParamSubstitution(this.template, aSearchTerms, aEngine);
  828.  
  829.     // Create an application/x-www-form-urlencoded representation of our params
  830.     // (name=value&name=value&name=value)
  831.     var dataString = "";
  832.     for (var i = 0; i < this.params.length; ++i) {
  833.       var param = this.params[i];
  834.       var value = ParamSubstitution(param.value, aSearchTerms, aEngine);
  835.  
  836.       dataString += (i > 0 ? "&" : "") + param.name + "=" + value;
  837.     }
  838.  
  839.     var postData = null;
  840.     if (this.method == "GET") {
  841.       // GET method requests have no post data, and append the encoded
  842.       // query string to the url...
  843.       if (url.indexOf("?") == -1 && dataString)
  844.         url += "?";
  845.       url += dataString;
  846.     } else if (this.method == "POST") {
  847.       // POST method requests must wrap the encoded text in a MIME
  848.       // stream and supply that as POSTDATA.
  849.       var stringStream = Cc["@mozilla.org/io/string-input-stream;1"].
  850.                          createInstance(Ci.nsIStringInputStream);
  851. //@line 893 "/cygdrive/K/tinderbuild/src/flock/mozilla/browser/components/search/nsSearchService.js"
  852.       stringStream.setData(dataString, dataString.length);
  853. //@line 897 "/cygdrive/K/tinderbuild/src/flock/mozilla/browser/components/search/nsSearchService.js"
  854.  
  855.       postData = Cc["@mozilla.org/network/mime-input-stream;1"].
  856.                  createInstance(Ci.nsIMIMEInputStream);
  857.       postData.addHeader("Content-Type", "application/x-www-form-urlencoded");
  858.       postData.addContentLength = true;
  859.       postData.setData(stringStream);
  860.     }
  861.  
  862.     return new Submission(makeURI(url), postData);
  863.   },
  864.  
  865.   /**
  866.    * Serializes the engine object to a OpenSearch Url element.
  867.    * @param aDoc
  868.    *        The document to use to create the Url element.
  869.    * @param aElement
  870.    *        The element to which the created Url element is appended.
  871.    *
  872.    * @see http://opensearch.a9.com/spec/1.1/querysyntax/#urltag
  873.    */
  874.   _serializeToElement: function SRCH_EURL_serializeToEl(aDoc, aElement) {
  875.     var url = aDoc.createElementNS(OPENSEARCH_NS_11, "Url");
  876.     url.setAttribute("type", this.type);
  877.     url.setAttribute("method", this.method);
  878.     url.setAttribute("template", this.template);
  879.  
  880.     for (var i = 0; i < this.params.length; ++i) {
  881.       var param = aDoc.createElementNS(OPENSEARCH_NS_11, "Param");
  882.       param.setAttribute("name", this.params[i].name);
  883.       param.setAttribute("value", this.params[i].value);
  884.       url.appendChild(aDoc.createTextNode("\n  "));
  885.       url.appendChild(param);
  886.     }
  887.     url.appendChild(aDoc.createTextNode("\n"));
  888.     aElement.appendChild(url);
  889.   }
  890. };
  891.  
  892. /**
  893.  * nsISearchEngine constructor.
  894.  * @param aLocation
  895.  *        A nsILocalFile or nsIURI object representing the location of the
  896.  *        search engine data file.
  897.  * @param aSourceDataType
  898.  *        The data type of the file used to describe the engine. Must be either
  899.  *        DATA_XML or DATA_TEXT.
  900.  * @param aIsReadOnly
  901.  *        Boolean indicating whether the engine should be treated as read-only.
  902.  *        Read only engines cannot be serialized to file.
  903.  */
  904. function Engine(aLocation, aSourceDataType, aIsReadOnly) {
  905.   this._dataType = aSourceDataType;
  906.   this._readOnly = aIsReadOnly;
  907.   this._urls = [];
  908.  
  909.   if (aLocation instanceof Ci.nsILocalFile) {
  910.     // we already have a file (e.g. loading engines from disk)
  911.     this._file = aLocation;
  912.   } else if (aLocation instanceof Ci.nsIURI) {
  913.     this._uri = aLocation;
  914.     switch (aLocation.scheme) {
  915.       case "https":
  916.       case "http":
  917.       case "ftp":
  918.       case "data":
  919.       case "file":
  920.       case "resource":
  921.         this._uri = aLocation;
  922.         break;
  923.       default:
  924.         ERROR("Invalid URI passed to the nsISearchEngine constructor",
  925.               Cr.NS_ERROR_INVALID_ARG);
  926.     }
  927.   } else
  928.     ERROR("Engine location is neither a File nor a URI object",
  929.           Cr.NS_ERROR_INVALID_ARG);
  930. }
  931.  
  932. Engine.prototype = {
  933.   // The engine's alias.
  934.   _alias: null,
  935.   // The data describing the engine. Is either an array of bytes, for Sherlock
  936.   // files, or an XML document element, for XML plugins.
  937.   _data: null,
  938.   // The engine's data type. See data types (DATA_) defined above.
  939.   _dataType: null,
  940.   // Whether or not the engine is readonly.
  941.   _readOnly: true,
  942.   // The engine's description
  943.   _description: "",
  944.   // Used to store the engine to replace, if we're an update to an existing
  945.   // engine.
  946.   _engineToUpdate: null,
  947.   // The file from which the plugin was loaded.
  948.   _file: null,
  949.   // If an engine was converted from an old style file, that file is saved here.
  950.   _unconvertedFile: null,
  951.   // Set to true if the engine has a preferred icon (an icon that should not be
  952.   // overridden by a non-preferred icon).
  953.   _hasPreferredIcon: null,
  954.   // Whether the engine is hidden from the user.
  955.   _hidden: null,
  956.   // The engine's name.
  957.   _name: null,
  958.   // The engine type. See engine types (TYPE_) defined above.
  959.   _type: null,
  960.   // The name of the charset used to submit the search terms.
  961.   _queryCharset: null,
  962.   // A URL string pointing to the engine's search form.
  963.   _searchForm: null,
  964.   // The URI object from which the engine was retrieved.
  965.   // This is null for local plugins, and is used for error messages and logging.
  966.   _uri: null,
  967.   // Whether to obtain user confirmation before adding the engine. This is only
  968.   // used when the engine is first added to the list.
  969.   _confirm: false,
  970.   // Whether to set this as the current engine as soon as it is loaded.  This
  971.   // is only used when the engine is first added to the list.
  972.   _useNow: false,
  973.   // Whether the search engine file is in the app dir.
  974.   __isInAppDir: null,
  975.   // The number of days between update checks for new versions
  976.   _updateInterval: null,
  977.   // The url to check at for a new update
  978.   _updateURL: null,
  979.   // The url to check for a new icon
  980.   _iconUpdateURL: null,
  981.  
  982.   /**
  983.    * Retrieves the data from the engine's file. If the engine's dataType is
  984.    * XML, the document element is placed in the engine's data field. For text
  985.    * engines, the data is just read directly from file and placed as an array
  986.    * of lines in the engine's data field.
  987.    */
  988.   _initFromFile: function SRCH_ENG_initFromFile() {
  989.     ENSURE(this._file && this._file.exists(),
  990.            "File must exist before calling initFromFile!",
  991.            Cr.NS_ERROR_UNEXPECTED);
  992.  
  993.     var fileInStream = Cc["@mozilla.org/network/file-input-stream;1"].
  994.                        createInstance(Ci.nsIFileInputStream);
  995.  
  996.     fileInStream.init(this._file, MODE_RDONLY, PERMS_FILE, false);
  997.  
  998.     switch (this._dataType) {
  999.       case SEARCH_DATA_XML:
  1000.  
  1001.         var domParser = Cc["@mozilla.org/xmlextras/domparser;1"].
  1002.                         createInstance(Ci.nsIDOMParser);
  1003.         var doc = domParser.parseFromStream(fileInStream, "UTF-8",
  1004.                                             this._file.fileSize,
  1005.                                             "text/xml");
  1006.  
  1007.         this._data = doc.documentElement;
  1008.         break;
  1009.       case SEARCH_DATA_TEXT:
  1010.         var binaryInStream = Cc["@mozilla.org/binaryinputstream;1"].
  1011.                              createInstance(Ci.nsIBinaryInputStream);
  1012.         binaryInStream.setInputStream(fileInStream);
  1013.  
  1014.         var bytes = binaryInStream.readByteArray(binaryInStream.available());
  1015.         this._data = bytes;
  1016.  
  1017.         break;
  1018.       default:
  1019.         ERROR("Bogus engine _dataType: \"" + this._dataType + "\"",
  1020.               Cr.NS_ERROR_UNEXPECTED);
  1021.     }
  1022.     fileInStream.close();
  1023.  
  1024.     // Now that the data is loaded, initialize the engine object
  1025.     this._initFromData();
  1026.   },
  1027.  
  1028.   /**
  1029.    * Retrieves the engine data from a URI.
  1030.    */
  1031.   _initFromURI: function SRCH_ENG_initFromURI() {
  1032.     ENSURE_WARN(this._uri instanceof Ci.nsIURI,
  1033.                 "Must have URI when calling _initFromURI!",
  1034.                 Cr.NS_ERROR_UNEXPECTED);
  1035.  
  1036.     LOG("_initFromURI: Downloading engine from: \"" + this._uri.spec + "\".");
  1037.  
  1038.     var ios = Cc["@mozilla.org/network/io-service;1"].
  1039.               getService(Ci.nsIIOService);
  1040.     var chan = ios.newChannelFromURI(this._uri);
  1041.  
  1042.     if (this._engineToUpdate && (chan instanceof Ci.nsIHttpChannel)) {
  1043.       var lastModified = engineMetadataService.getAttr(this._engineToUpdate,
  1044.                                                        "updatelastmodified");
  1045.       if (lastModified)
  1046.         chan.setRequestHeader("If-Modified-Since", lastModified, false);
  1047.     }
  1048.     var listener = new loadListener(chan, this, this._onLoad);
  1049.     chan.notificationCallbacks = listener;
  1050.     chan.asyncOpen(listener, null);
  1051.   },
  1052.  
  1053.   /**
  1054.    * Attempts to find an EngineURL object in the set of EngineURLs for
  1055.    * this Engine that has the given type string.  (This corresponds to the
  1056.    * "type" attribute in the "Url" node in the OpenSearch spec.)
  1057.    * This method will return the first matching URL object found, or null
  1058.    * if no matching URL is found.
  1059.    *
  1060.    * @param aType string to match the EngineURL's type attribute
  1061.    */
  1062.   _getURLOfType: function SRCH_ENG__getURLOfType(aType) {
  1063.     for (var i = 0; i < this._urls.length; ++i) {
  1064.       if (this._urls[i].type == aType)
  1065.         return this._urls[i];
  1066.     }
  1067.  
  1068.     return null;
  1069.   },
  1070.  
  1071.   _confirmAddEngine: function SRCH_SVC_confirmAddEngine() {
  1072.     var sbs = Cc["@mozilla.org/intl/stringbundle;1"].
  1073.               getService(Ci.nsIStringBundleService);
  1074.     var stringBundle = sbs.createBundle(SIDEBAR_BUNDLE);
  1075.     var titleMessage = stringBundle.GetStringFromName("addEngineConfirmTitle");
  1076.  
  1077.     // Display only the hostname portion of the URL.
  1078.     var dialogMessage =
  1079.         stringBundle.formatStringFromName("addEngineConfirmText",
  1080.                                           [this._name, this._uri.host], 2);
  1081.     var addButtonLabel =
  1082.         stringBundle.GetStringFromName("addEngineAddButtonLabel");
  1083.  
  1084.     var ps = Cc["@mozilla.org/embedcomp/prompt-service;1"].
  1085.              getService(Ci.nsIPromptService);
  1086.     var buttonFlags = (ps.BUTTON_TITLE_IS_STRING * ps.BUTTON_POS_0) +
  1087.                       (ps.BUTTON_TITLE_CANCEL    * ps.BUTTON_POS_1) +
  1088.                        ps.BUTTON_POS_0_DEFAULT;
  1089.  
  1090.     var checked = {value: false};
  1091.     // confirmEx returns the index of the button that was pressed.  Since "Add"
  1092.     // is button 0, we want to return the negation of that value.
  1093.     var confirm = !ps.confirmEx(null,
  1094.                                 titleMessage,
  1095.                                 dialogMessage,
  1096.                                 buttonFlags,
  1097.                                 addButtonLabel,
  1098.                                 null, null, // button 1 & 2 names not used
  1099.                                 null, // Add Now not used.
  1100.                                 checked);
  1101.  
  1102.     return {confirmed: confirm, useNow: checked.value};
  1103.   },
  1104.  
  1105.   /**
  1106.    * Handle the successful download of an engine. Initializes the engine and
  1107.    * triggers parsing of the data. The engine is then flushed to disk. Notifies
  1108.    * the search service once initialization is complete.
  1109.    */
  1110.   _onLoad: function SRCH_ENG_onLoad(aBytes, aEngine) {
  1111.     /**
  1112.      * Handle an error during the load of an engine by prompting the user to
  1113.      * notify him that the load failed.
  1114.      */
  1115.     function onError(aErrorString, aTitleString) {
  1116.       if (aEngine._engineToUpdate) {
  1117.         // We're in an update, so just fail quietly
  1118.         LOG("updating " + aEngine._engineToUpdate.name + " failed");
  1119.         return;
  1120.       }
  1121.  
  1122.       var sbs = Cc["@mozilla.org/intl/stringbundle;1"].
  1123.                 getService(Ci.nsIStringBundleService);
  1124.  
  1125.       var brandBundle = sbs.createBundle(BRAND_BUNDLE);
  1126.       var brandName = brandBundle.GetStringFromName("brandShortName");
  1127.  
  1128.       var searchBundle = sbs.createBundle(SEARCH_BUNDLE);
  1129.       var msgStringName = aErrorString || "error_loading_engine_msg2";
  1130.       var titleStringName = aTitleString || "error_loading_engine_title";
  1131.       var title = searchBundle.GetStringFromName(titleStringName);
  1132.       var text = searchBundle.formatStringFromName(msgStringName,
  1133.                                                    [brandName, aEngine._location],
  1134.                                                    2);
  1135.  
  1136.       var ww = Cc["@mozilla.org/embedcomp/window-watcher;1"].
  1137.                getService(Ci.nsIWindowWatcher);
  1138.       ww.getNewPrompter(null).alert(title, text);
  1139.     }
  1140.  
  1141.     if (!aBytes) {
  1142.       onError();
  1143.       return;
  1144.     }
  1145.  
  1146.     var engineToUpdate = null;
  1147.     if (aEngine._engineToUpdate) {
  1148.       engineToUpdate = aEngine._engineToUpdate.wrappedJSObject;
  1149.  
  1150.       // Make this new engine use the old engine's file.
  1151.       aEngine._file = engineToUpdate._file;
  1152.     }
  1153.  
  1154.     switch (aEngine._dataType) {
  1155.       case SEARCH_DATA_XML:
  1156.         var dataString = bytesToString(aBytes, "UTF-8");
  1157.         ENSURE(dataString, "_onLoad: Couldn't convert byte array!",
  1158.                Cr.NS_ERROR_FAILURE);
  1159.         var parser = Cc["@mozilla.org/xmlextras/domparser;1"].
  1160.                      createInstance(Ci.nsIDOMParser);
  1161.         var doc = parser.parseFromString(dataString, "text/xml");
  1162.         aEngine._data = doc.documentElement;
  1163.         break;
  1164.       case SEARCH_DATA_TEXT:
  1165.         aEngine._data = aBytes;
  1166.         break;
  1167.       default:
  1168.         onError();
  1169.         LOG("_onLoad: Bogus engine _dataType: \"" + this._dataType + "\"");
  1170.         return;
  1171.     }
  1172.  
  1173.     try {
  1174.       // Initialize the engine from the obtained data
  1175.       aEngine._initFromData();
  1176.     } catch (ex) {
  1177.       LOG("_onLoad: Failed to init engine!\n" + ex);
  1178.       // Report an error to the user
  1179.       onError();
  1180.       return;
  1181.     }
  1182.  
  1183.     // Check to see if this is a duplicate engine. If we're confirming the
  1184.     // engine load, then we display a "this is a duplicate engine" prompt,
  1185.     // otherwise we fail silently.
  1186.     if (!engineToUpdate) {
  1187.       var ss = Cc["@mozilla.org/browser/search-service;1"].
  1188.                getService(Ci.nsIBrowserSearchService);
  1189.       if (ss.getEngineByName(aEngine.name)) {
  1190.         if (aEngine._confirm)
  1191.           onError("error_duplicate_engine_msg", "error_invalid_engine_title");
  1192.  
  1193.         LOG("_onLoad: duplicate engine found, bailing");
  1194.         return;
  1195.       }
  1196.     }
  1197.  
  1198.     // If requested, confirm the addition now that we have the title.
  1199.     // This property is only ever true for engines added via
  1200.     // nsIBrowserSearchService::addEngine.
  1201.     if (aEngine._confirm) {
  1202.       var confirmation = aEngine._confirmAddEngine();
  1203.       LOG("_onLoad: confirm is " + confirmation.confirmed +
  1204.           "; useNow is " + confirmation.useNow);
  1205.       if (!confirmation.confirmed)
  1206.         return;
  1207.       aEngine._useNow = confirmation.useNow;
  1208.     }
  1209.  
  1210.     // If we don't yet have a file, get one now. The only case where we would
  1211.     // already have a file is if this is an update and _file was set above.
  1212.     if (!aEngine._file)
  1213.       aEngine._file = getSanitizedFile(aEngine.name);
  1214.  
  1215.     if (engineToUpdate) {
  1216.       // Keep track of the last modified date, so that we can make conditional
  1217.       // requests for future updates.
  1218.       engineMetadataService.setAttr(aEngine, "updatelastmodified",
  1219.                                     (new Date()).toUTCString());
  1220.  
  1221.       // Set the new engine's icon, if it doesn't yet have one.
  1222.       if (!aEngine._iconURI && engineToUpdate._iconURI)
  1223.         aEngine._iconURI = engineToUpdate._iconURI;
  1224.  
  1225.       // Clear the "use now" flag since we don't want to be changing the
  1226.       // current engine for an update.
  1227.       aEngine._useNow = false;
  1228.     }
  1229.  
  1230.     // Write the engine to file
  1231.     aEngine._serializeToFile();
  1232.  
  1233.     // Notify the search service of the sucessful load. It will deal with
  1234.     // updates by checking aEngine._engineToUpdate.
  1235.     notifyAction(aEngine, SEARCH_ENGINE_LOADED);
  1236.   },
  1237.  
  1238.   /**
  1239.    * Sets the .iconURI property of the engine.
  1240.    *
  1241.    *  @param aIconURL
  1242.    *         A URI string pointing to the engine's icon. Must have a http[s],
  1243.    *         ftp, or data scheme. Icons with HTTP[S] or FTP schemes will be
  1244.    *         downloaded and converted to data URIs for storage in the engine
  1245.    *         XML files, if the engine is not readonly.
  1246.    *  @param aIsPreferred
  1247.    *         Whether or not this icon is to be preferred. Preferred icons can
  1248.    *         override non-preferred icons.
  1249.    */
  1250.   _setIcon: function SRCH_ENG_setIcon(aIconURL, aIsPreferred) {
  1251.     // If we already have a preferred icon, and this isn't a preferred icon,
  1252.     // just ignore it.
  1253.     if (this._hasPreferredIcon && !aIsPreferred)
  1254.       return;
  1255.  
  1256.     var uri = makeURI(aIconURL);
  1257.  
  1258.     // Ignore bad URIs
  1259.     if (!uri)
  1260.       return;
  1261.  
  1262.     LOG("_setIcon: Setting icon url \"" + uri.spec + "\" for engine \""
  1263.         + this.name + "\".");
  1264.     // Only accept remote icons from http[s] or ftp
  1265.     switch (uri.scheme) {
  1266.       case "data":
  1267.         this._iconURI = uri;
  1268.         notifyAction(this, SEARCH_ENGINE_CHANGED);
  1269.         this._hasPreferredIcon = aIsPreferred;
  1270.         break;
  1271.       case "http":
  1272.       case "https":
  1273.       case "ftp":
  1274.         // No use downloading the icon if the engine file is read-only
  1275.         if (!this._readOnly) {
  1276.           LOG("_setIcon: Downloading icon: \"" + uri.spec +
  1277.               "\" for engine: \"" + this.name + "\"");
  1278.           var ios = Cc["@mozilla.org/network/io-service;1"].
  1279.                     getService(Ci.nsIIOService);
  1280.           var chan = ios.newChannelFromURI(uri);
  1281.  
  1282.           function iconLoadCallback(aByteArray, aEngine) {
  1283.             // This callback may run after we've already set a preferred icon,
  1284.             // so check again.
  1285.             if (aEngine._hasPreferredIcon && !aIsPreferred)
  1286.               return;
  1287.  
  1288.             if (!aByteArray || aByteArray.length > MAX_ICON_SIZE) {
  1289.               LOG("iconLoadCallback: load failed, or the icon was too large!");
  1290.               return;
  1291.             }
  1292.  
  1293.             var str = b64(aByteArray);
  1294.             aEngine._iconURI = makeURI(ICON_DATAURL_PREFIX + str);
  1295.  
  1296.             // The engine might not have a file yet, if it's being downloaded,
  1297.             // because the request for the engine file itself (_onLoad) may not
  1298.             // yet be complete. In that case, this change will be written to
  1299.             // file when _onLoad is called.
  1300.             if (aEngine._file)
  1301.               aEngine._serializeToFile();
  1302.  
  1303.             notifyAction(aEngine, SEARCH_ENGINE_CHANGED);
  1304.             aEngine._hasPreferredIcon = aIsPreferred;
  1305.           }
  1306.  
  1307.           // If we're currently acting as an "update engine", then the callback
  1308.           // should set the icon on the engine we're updating and not us, since
  1309.           // |this| might be gone by the time the callback runs.
  1310.           var engineToSet = this._engineToUpdate || this;
  1311.  
  1312.           var listener = new loadListener(chan, engineToSet, iconLoadCallback);
  1313.           chan.notificationCallbacks = listener;
  1314.           chan.asyncOpen(listener, null);
  1315.         }
  1316.         break;
  1317.     }
  1318.   },
  1319.  
  1320.   /**
  1321.    * Initialize this Engine object from the collected data.
  1322.    */
  1323.   _initFromData: function SRCH_ENG_initFromData() {
  1324.  
  1325.     ENSURE_WARN(this._data, "Can't init an engine with no data!",
  1326.                 Cr.NS_ERROR_UNEXPECTED);
  1327.  
  1328.     // Find out what type of engine we are
  1329.     switch (this._dataType) {
  1330.       case SEARCH_DATA_XML:
  1331.         if (checkNameSpace(this._data, [MOZSEARCH_LOCALNAME],
  1332.             [MOZSEARCH_NS_10])) {
  1333.  
  1334.           LOG("_init: Initing MozSearch plugin from " + this._location);
  1335.  
  1336.           this._type = SEARCH_TYPE_MOZSEARCH;
  1337.           this._parseAsMozSearch();
  1338.  
  1339.         } else if (checkNameSpace(this._data, [OPENSEARCH_LOCALNAME],
  1340.                                   OPENSEARCH_NAMESPACES)) {
  1341.  
  1342.           LOG("_init: Initing OpenSearch plugin from " + this._location);
  1343.  
  1344.           this._type = SEARCH_TYPE_OPENSEARCH;
  1345.           this._parseAsOpenSearch();
  1346.  
  1347.         } else
  1348.           ENSURE(false, this._location + " is not a valid search plugin.",
  1349.                  Cr.NS_ERROR_FAILURE);
  1350.  
  1351.         break;
  1352.       case SEARCH_DATA_TEXT:
  1353.         LOG("_init: Initing Sherlock plugin from " + this._location);
  1354.  
  1355.         // the only text-based format we support is Sherlock
  1356.         this._type = SEARCH_TYPE_SHERLOCK;
  1357.         this._parseAsSherlock();
  1358.     }
  1359.   },
  1360.  
  1361.   /**
  1362.    * Initialize this Engine object from a collection of metadata.
  1363.    */
  1364.   _initFromMetadata: function SRCH_ENG_initMetaData(aName, aIconURL, aAlias,
  1365.                                                     aDescription, aMethod,
  1366.                                                     aTemplate) {
  1367.     ENSURE_WARN(!this._readOnly,
  1368.                 "Can't call _initFromMetaData on a readonly engine!",
  1369.                 Cr.NS_ERROR_FAILURE);
  1370.  
  1371.     this._urls.push(new EngineURL("text/html", aMethod, aTemplate));
  1372.  
  1373.     this._name = aName;
  1374.     this._alias = aAlias;
  1375.     this._description = aDescription;
  1376.     this._setIcon(aIconURL, true);
  1377.  
  1378.     this._serializeToFile();
  1379.   },
  1380.  
  1381.   /**
  1382.    * Extracts data from an OpenSearch URL element and creates an EngineURL
  1383.    * object which is then added to the engine's list of URLs.
  1384.    *
  1385.    * @throws NS_ERROR_FAILURE if a URL object could not be created.
  1386.    *
  1387.    * @see http://opensearch.a9.com/spec/1.1/querysyntax/#urltag.
  1388.    * @see EngineURL()
  1389.    */
  1390.   _parseURL: function SRCH_ENG_parseURL(aElement) {
  1391.     var type     = aElement.getAttribute("type");
  1392.     // According to the spec, method is optional, defaulting to "GET" if not
  1393.     // specified
  1394.     var method   = aElement.getAttribute("method") || "GET";
  1395.     var template = aElement.getAttribute("template");
  1396.  
  1397.     try {
  1398.       var url = new EngineURL(type, method, template);
  1399.     } catch (ex) {
  1400.       LOG("_parseURL: failed to add " + template + " as a URL");
  1401.       throw Cr.NS_ERROR_FAILURE;
  1402.     }
  1403.  
  1404.     for (var i = 0; i < aElement.childNodes.length; ++i) {
  1405.       var param = aElement.childNodes[i];
  1406.       if (param.localName == "Param") {
  1407.         try {
  1408.           url.addParam(param.getAttribute("name"), param.getAttribute("value"));
  1409.         } catch (ex) {
  1410.           // Ignore failure
  1411.           LOG("_parseURL: Url element has an invalid param");
  1412.         }
  1413.       } else if (param.localName == "MozParam" &&
  1414.                  // We only support MozParams for appdir-shipped search engines
  1415.                  this._isInAppDir) {
  1416.         var value;
  1417.         switch (param.getAttribute("condition")) {
  1418.           case "defaultEngine":
  1419.             const defPref = BROWSER_SEARCH_PREF + "defaultenginename";
  1420.             var defaultPrefB = Cc["@mozilla.org/preferences-service;1"].
  1421.                                getService(Ci.nsIPrefService).
  1422.                                getDefaultBranch(null);
  1423.             const nsIPLS = Ci.nsIPrefLocalizedString;
  1424.             var defaultName;
  1425.             try {
  1426.               defaultName = defaultPrefB.getComplexValue(defPref, nsIPLS).data;
  1427.             } catch (ex) {}
  1428.  
  1429.             // If this engine was the default search engine, use the true value
  1430.             if (this.name == defaultName)
  1431.               value = param.getAttribute("trueValue");
  1432.             else
  1433.               value = param.getAttribute("falseValue");
  1434.             url.addParam(param.getAttribute("name"), value);
  1435.             break;
  1436.  
  1437.           case "pref":
  1438.             try {
  1439.               var prefB = Cc["@mozilla.org/preferences-service;1"].
  1440.                           getService(Ci.nsIPrefBranch);
  1441.               value = prefB.getCharPref(BROWSER_SEARCH_PREF + "param." +
  1442.                                         param.getAttribute("pref"));
  1443.               url.addParam(param.getAttribute("name"), value);
  1444.             } catch (e) { }
  1445.             break;
  1446.         }
  1447.       }
  1448.     }
  1449.  
  1450.     this._urls.push(url);
  1451.   },
  1452.  
  1453.   /**
  1454.    * Get the icon from an OpenSearch Image element.
  1455.    * @see http://opensearch.a9.com/spec/1.1/description/#image
  1456.    */
  1457.   _parseImage: function SRCH_ENG_parseImage(aElement) {
  1458.     LOG("_parseImage: Image textContent: \"" + aElement.textContent + "\"");
  1459.     if (aElement.getAttribute("width")  == "16" &&
  1460.         aElement.getAttribute("height") == "16") {
  1461.       this._setIcon(aElement.textContent, true);
  1462.     }
  1463.   },
  1464.  
  1465.   _parseAsMozSearch: function SRCH_ENG_parseAsMoz() {
  1466.     //forward to the OpenSearch parser
  1467.     this._parseAsOpenSearch();
  1468.   },
  1469.  
  1470.   /**
  1471.    * Extract search engine information from the collected data to initialize
  1472.    * the engine object.
  1473.    */
  1474.   _parseAsOpenSearch: function SRCH_ENG_parseAsOS() {
  1475.     var doc = this._data;
  1476.  
  1477.     // The OpenSearch spec sets a default value for the input encoding.
  1478.     this._queryCharset = OS_PARAM_INPUT_ENCODING_DEF;
  1479.  
  1480.     for (var i = 0; i < doc.childNodes.length; ++i) {
  1481.       var child = doc.childNodes[i];
  1482.       switch (child.localName) {
  1483.         case "ShortName":
  1484.           this._name = child.textContent;
  1485.           break;
  1486.         case "Description":
  1487.           this._description = child.textContent;
  1488.           break;
  1489.         case "Url":
  1490.           try {
  1491.             this._parseURL(child);
  1492.           } catch (ex) {
  1493.             // Parsing of the element failed, just skip it.
  1494.           }
  1495.           break;
  1496.         case "Image":
  1497.           this._parseImage(child);
  1498.           break;
  1499.         case "InputEncoding":
  1500.           this._queryCharset = child.textContent.toUpperCase();
  1501.           break;
  1502.  
  1503.         // Non-OpenSearch elements
  1504.         case "Alias":
  1505.           this._alias = child.textContent;
  1506.           break;
  1507.         case "SearchForm":
  1508.           this._searchForm = child.textContent;
  1509.           break;
  1510.         case "UpdateUrl":
  1511.           this._updateURL = child.textContent;
  1512.           break;
  1513.         case "UpdateInterval":
  1514.           this._updateInterval = parseInt(child.textContent);
  1515.           break;
  1516.         case "IconUpdateUrl":
  1517.           this._iconUpdateURL = child.textContent;
  1518.           break;
  1519.       }
  1520.     }
  1521.     ENSURE(this.name && (this._urls.length > 0),
  1522.            "_parseAsOpenSearch: No name, or missing URL!",
  1523.            Cr.NS_ERROR_FAILURE);
  1524.     ENSURE(this.supportsResponseType(URLTYPE_SEARCH_HTML),
  1525.            "_parseAsOpenSearch: No text/html result type!",
  1526.            Cr.NS_ERROR_FAILURE);
  1527.   },
  1528.  
  1529.   /**
  1530.    * Extract search engine information from the collected data to initialize
  1531.    * the engine object.
  1532.    */
  1533.   _parseAsSherlock: function SRCH_ENG_parseAsSherlock() {
  1534.     /**
  1535.      * Trims leading and trailing whitespace from aStr.
  1536.      */
  1537.     function sTrim(aStr) {
  1538.       return aStr.replace(/^\s+/g, "").replace(/\s+$/g, "");
  1539.     }
  1540.  
  1541.     /**
  1542.      * Extracts one Sherlock "section" from aSource. A section is essentially
  1543.      * an HTML element with attributes, but each attribute must be on a new
  1544.      * line, by definition.
  1545.      *
  1546.      * @param aLines
  1547.      *        An array of lines from the sherlock file.
  1548.      * @param aSection
  1549.      *        The name of the section (e.g. "search" or "browser"). This value
  1550.      *        is not case sensitive.
  1551.      * @returns an object whose properties correspond to the section's
  1552.      *          attributes.
  1553.      */
  1554.     function getSection(aLines, aSection) {
  1555.       LOG("_parseAsSherlock::getSection: Sherlock lines:\n" +
  1556.           aLines.join("\n"));
  1557.       var lines = aLines;
  1558.       var startMark = new RegExp("^\\s*<" + aSection.toLowerCase() + "\\s*",
  1559.                                  "gi");
  1560.       var endMark   = /\s*>\s*$/gi;
  1561.  
  1562.       var foundStart = false;
  1563.       var startLine, numberOfLines;
  1564.       // Find the beginning and end of the section
  1565.       for (var i = 0; i < lines.length; i++) {
  1566.         if (foundStart) {
  1567.           if (endMark.test(lines[i])) {
  1568.             numberOfLines = i - startLine;
  1569.             // Remove the end marker
  1570.             lines[i] = lines[i].replace(endMark, "");
  1571.             // If the endmarker was not the only thing on the line, include
  1572.             // this line in the results
  1573.             if (lines[i])
  1574.               numberOfLines++;
  1575.             break;
  1576.           }
  1577.         } else {
  1578.           if (startMark.test(lines[i])) {
  1579.             foundStart = true;
  1580.             // Remove the start marker
  1581.             lines[i] = lines[i].replace(startMark, "");
  1582.             startLine = i;
  1583.             // If the line is empty, don't include it in the result
  1584.             if (!lines[i])
  1585.               startLine++;
  1586.           }
  1587.         }
  1588.       }
  1589.       LOG("_parseAsSherlock::getSection: Start index: " + startLine +
  1590.           "\nNumber of lines: " + numberOfLines);
  1591.       lines = lines.splice(startLine, numberOfLines);
  1592.       LOG("_parseAsSherlock::getSection: Section lines:\n" +
  1593.           lines.join("\n"));
  1594.  
  1595.       var section = {};
  1596.       for (var i = 0; i < lines.length; i++) {
  1597.         var line = sTrim(lines[i]);
  1598.  
  1599.         var els = line.split("=");
  1600.         var name = sTrim(els.shift().toLowerCase());
  1601.         var value = sTrim(els.join("="));
  1602.  
  1603.         if (!name || !value)
  1604.           continue;
  1605.  
  1606.         // Strip leading and trailing whitespace, remove quotes from the
  1607.         // value, and remove any trailing slashes or ">" characters
  1608.         value = value.replace(/^["']/, "")
  1609.                      .replace(/["']\s*[\\\/]?>?\s*$/, "") || "";
  1610.         value = sTrim(value);
  1611.  
  1612.         // Don't clobber existing attributes
  1613.         if (!(name in section))
  1614.           section[name] = value;
  1615.       }
  1616.       return section;
  1617.     }
  1618.  
  1619.     /**
  1620.      * Returns an array of name-value pair arrays representing the Sherlock
  1621.      * file's input elements. User defined inputs return USER_DEFINED
  1622.      * as the value. Elements are returned in the order they appear in the
  1623.      * source file.
  1624.      *
  1625.      *   Example:
  1626.      *      <input name="foo" value="bar">
  1627.      *      <input name="foopy" user>
  1628.      *   Returns:
  1629.      *      [["foo", "bar"], ["foopy", "{searchTerms}"]]
  1630.      *
  1631.      * @param aLines
  1632.      *        An array of lines from the source file.
  1633.      */
  1634.     function getInputs(aLines) {
  1635.  
  1636.       /**
  1637.        * Extracts an attribute value from a given a line of text.
  1638.        *    Example: <input value="foo" name="bar">
  1639.        *      Extracts the string |foo| or |bar| given an input aAttr of
  1640.        *      |value| or |name|.
  1641.        * Attributes may be quoted or unquoted. If unquoted, any whitespace
  1642.        * indicates the end of the attribute value.
  1643.        *    Example: < value=22 33 name=44\334 >
  1644.        *      Returns |22| for "value" and |44\334| for "name".
  1645.        *
  1646.        * @param aAttr
  1647.        *        The name of the attribute for which to obtain the value. This
  1648.        *        value is not case sensitive.
  1649.        * @param aLine
  1650.        *        The line containing the attribute.
  1651.        *
  1652.        * @returns the attribute value, or an empty string if the attribute
  1653.        *          doesn't exist.
  1654.        */
  1655.       function getAttr(aAttr, aLine) {
  1656.         // Used to determine whether an "input" line from a Sherlock file is a
  1657.         // "user defined" input.
  1658.         const userInput = /(\s|["'=])user(\s|[>="'\/\\+]|$)/i;
  1659.  
  1660.         LOG("_parseAsSherlock::getAttr: Getting attr: \"" +
  1661.             aAttr + "\" for line: \"" + aLine + "\"");
  1662.         // We're not case sensitive, but we want to return the attribute value
  1663.         // in its original case, so create a copy of the source
  1664.         var lLine = aLine.toLowerCase();
  1665.         var attr = aAttr.toLowerCase();
  1666.  
  1667.         var attrStart = lLine.search(new RegExp("\\s" + attr, "i"));
  1668.         if (attrStart == -1) {
  1669.  
  1670.           // If this is the "user defined input" (i.e. contains the empty
  1671.           // "user" attribute), return our special keyword
  1672.           if (userInput.test(lLine) && attr == "value") {
  1673.             LOG("_parseAsSherlock::getAttr: Found user input!\nLine:\"" + lLine
  1674.                 + "\"");
  1675.             return USER_DEFINED;
  1676.           }
  1677.           // The attribute doesn't exist - ignore
  1678.           LOG("_parseAsSherlock::getAttr: Failed to find attribute:\nLine:\""
  1679.               + lLine + "\"\nAttr:\"" + attr + "\"");
  1680.           return "";
  1681.         }
  1682.  
  1683.         var valueStart = lLine.indexOf("=", attrStart) + "=".length;
  1684.         if (valueStart == -1)
  1685.           return "";
  1686.  
  1687.         var quoteStart = lLine.indexOf("\"", valueStart);
  1688.         if (quoteStart == -1) {
  1689.  
  1690.           // Unquoted attribute, get the rest of the line, trimmed at the first
  1691.           // sign of whitespace. If the rest of the line is only whitespace,
  1692.           // returns a blank string.
  1693.           return lLine.substr(valueStart).replace(/\s.*$/, "");
  1694.  
  1695.         } else {
  1696.           // Make sure that there's only whitespace between the start of the
  1697.           // value and the first quote. If there is, end the attribute value at
  1698.           // the first sign of whitespace. This prevents us from falling into
  1699.           // the next attribute if this is an unquoted attribute followed by a
  1700.           // quoted attribute.
  1701.           var betweenEqualAndQuote = lLine.substring(valueStart, quoteStart);
  1702.           if (/\S/.test(betweenEqualAndQuote))
  1703.             return lLine.substr(valueStart).replace(/\s.*$/, "");
  1704.  
  1705.           // Adjust the start index to account for the opening quote
  1706.           valueStart = quoteStart + "\"".length;
  1707.           // Find the closing quote
  1708.           valueEnd = lLine.indexOf("\"", valueStart);
  1709.           // If there is no closing quote, just go to the end of the line
  1710.           if (valueEnd == -1)
  1711.             valueEnd = aLine.length;
  1712.         }
  1713.         return aLine.substring(valueStart, valueEnd);
  1714.       }
  1715.  
  1716.       var inputs = [];
  1717.  
  1718.       LOG("_parseAsSherlock::getInputs: Lines:\n" + aLines);
  1719.       // Filter out everything but non-inputs
  1720.       lines = aLines.filter(function (line) {
  1721.         return /^\s*<input/i.test(line);
  1722.       });
  1723.       LOG("_parseAsSherlock::getInputs: Filtered lines:\n" + lines);
  1724.  
  1725.       lines.forEach(function (line) {
  1726.         // Strip leading/trailing whitespace and remove the surrounding markup
  1727.         // ("<input" and ">")
  1728.         line = sTrim(line).replace(/^<input/i, "").replace(/>$/, "");
  1729.  
  1730.         // If this is one of the "directional" inputs (<inputnext>/<inputprev>)
  1731.         const directionalInput = /^(prev|next)/i;
  1732.         if (directionalInput.test(line)) {
  1733.  
  1734.           // Make it look like a normal input by removing "prev" or "next"
  1735.           line = line.replace(directionalInput, "");
  1736.  
  1737.           // If it has a name, give it a dummy value to match previous
  1738.           // nsInternetSearchService behavior
  1739.           if (/name\s*=/i.test(line)) {
  1740.             line += " value=\"0\"";
  1741.           } else
  1742.             return; // Line has no name, skip it
  1743.         }
  1744.  
  1745.         var attrName = getAttr("name", line);
  1746.         var attrValue = getAttr("value", line);
  1747.         LOG("_parseAsSherlock::getInputs: Got input:\nName:\"" + attrName +
  1748.             "\"\nValue:\"" + attrValue + "\"");
  1749.         if (attrValue)
  1750.           inputs.push([attrName, attrValue]);
  1751.       });
  1752.       return inputs;
  1753.     }
  1754.  
  1755.     function err(aErr) {
  1756.       LOG("_parseAsSherlock::err: Sherlock param error:\n" + aErr);
  1757.       throw Cr.NS_ERROR_FAILURE;
  1758.     }
  1759.  
  1760.     // First try converting our byte array using the default Sherlock encoding.
  1761.     // If this fails, or if we find a sourceTextEncoding attribute, we need to
  1762.     // reconvert the byte array using the specified encoding.
  1763.     var sherlockLines, searchSection, sourceTextEncoding, browserSection;
  1764.     try {
  1765.       sherlockLines = sherlockBytesToLines(this._data);
  1766.       searchSection = getSection(sherlockLines, "search");
  1767.       browserSection = getSection(sherlockLines, "browser");
  1768.       sourceTextEncoding = parseInt(searchSection["sourcetextencoding"]);
  1769.       if (sourceTextEncoding) {
  1770.         // Re-convert the bytes using the found sourceTextEncoding
  1771.         sherlockLines = sherlockBytesToLines(this._data, sourceTextEncoding);
  1772.         searchSection = getSection(sherlockLines, "search");
  1773.         browserSection = getSection(sherlockLines, "browser");
  1774.       }
  1775.     } catch (ex) {
  1776.       // The conversion using the default charset failed. Remove any non-ascii
  1777.       // bytes and try to find a sourceTextEncoding.
  1778.       var asciiBytes = this._data.filter(function (n) {return !(0x80 & n);});
  1779.       var asciiString = String.fromCharCode.apply(null, asciiBytes);
  1780.       sherlockLines = asciiString.split(NEW_LINES).filter(isUsefulLine);
  1781.       searchSection = getSection(sherlockLines, "search");
  1782.       sourceTextEncoding = parseInt(searchSection["sourcetextencoding"]);
  1783.       if (sourceTextEncoding) {
  1784.         sherlockLines = sherlockBytesToLines(this._data, sourceTextEncoding);
  1785.         searchSection = getSection(sherlockLines, "search");
  1786.         browserSection = getSection(sherlockLines, "browser");
  1787.       } else
  1788.         ERROR("Couldn't find a working charset", Cr.NS_ERROR_FAILURE);
  1789.     }
  1790.  
  1791.     LOG("_parseAsSherlock: Search section:\n" + searchSection.toSource());
  1792.  
  1793.     this._name = searchSection["name"] || err("Missing name!");
  1794.     this._description = searchSection["description"] || "";
  1795.     this._queryCharset = searchSection["querycharset"] ||
  1796.                          queryCharsetFromCode(searchSection["queryencoding"]);
  1797.     this._searchForm = searchSection["searchform"];
  1798.  
  1799.     this._updateInterval = parseInt(browserSection["updatecheckdays"]);
  1800.  
  1801.     this._updateURL = browserSection["update"];
  1802.     this._iconUpdateURL = browserSection["updateicon"];
  1803.  
  1804.     var method = (searchSection["method"] || "GET").toUpperCase();
  1805.     var template = searchSection["action"] || err("Missing action!");
  1806.  
  1807.     var inputs = getInputs(sherlockLines);
  1808.     LOG("_parseAsSherlock: Inputs:\n" + inputs.toSource());
  1809.  
  1810.     var url = null;
  1811.  
  1812.     if (method == "GET") {
  1813.       // Here's how we construct the input string:
  1814.       // <input> is first:  Name Attr:  Prefix      Data           Example:
  1815.       // YES                EMPTY       None        <value>        TEMPLATE<value>
  1816.       // YES                NON-EMPTY   ?           <name>=<value> TEMPLATE?<name>=<value>
  1817.       // NO                 EMPTY       ------------- <ignored> --------------
  1818.       // NO                 NON-EMPTY   &           <name>=<value> TEMPLATE?<n1>=<v1>&<n2>=<v2>
  1819.       for (var i = 0; i < inputs.length; i++) {
  1820.         var name  = inputs[i][0];
  1821.         var value = inputs[i][1];
  1822.         if (i==0) {
  1823.           if (name == "")
  1824.             template += USER_DEFINED;
  1825.           else
  1826.             template += "?" + name + "=" + value;
  1827.         } else if (name != "")
  1828.           template += "&" + name + "=" + value;
  1829.       }
  1830.       url = new EngineURL("text/html", method, template);
  1831.  
  1832.     } else if (method == "POST") {
  1833.       // Create the URL object and just add the parameters directly
  1834.       url = new EngineURL("text/html", method, template);
  1835.       for (var i = 0; i < inputs.length; i++) {
  1836.         var name  = inputs[i][0];
  1837.         var value = inputs[i][1];
  1838.         if (name)
  1839.           url.addParam(name, value);
  1840.       }
  1841.     } else
  1842.       err("Invalid method!");
  1843.  
  1844.     this._urls.push(url);
  1845.   },
  1846.  
  1847.   /**
  1848.    * Returns an XML document object containing the search plugin information,
  1849.    * which can later be used to reload the engine.
  1850.    */
  1851.   _serializeToElement: function SRCH_ENG_serializeToEl() {
  1852.     function appendTextNode(aNameSpace, aLocalName, aValue) {
  1853.       if (!aValue)
  1854.         return null;
  1855.       var node = doc.createElementNS(aNameSpace, aLocalName);
  1856.       node.appendChild(doc.createTextNode(aValue));
  1857.       docElem.appendChild(node);
  1858.       docElem.appendChild(doc.createTextNode("\n"));
  1859.       return node;
  1860.     }
  1861.  
  1862.     var parser = Cc["@mozilla.org/xmlextras/domparser;1"].
  1863.                  createInstance(Ci.nsIDOMParser);
  1864.  
  1865.     var doc = parser.parseFromString(EMPTY_DOC, "text/xml");
  1866.     docElem = doc.documentElement;
  1867.  
  1868.     docElem.appendChild(doc.createTextNode("\n"));
  1869.  
  1870.     appendTextNode(OPENSEARCH_NS_11, "ShortName", this.name);
  1871.     appendTextNode(OPENSEARCH_NS_11, "Description", this._description);
  1872.     appendTextNode(OPENSEARCH_NS_11, "InputEncoding", this._queryCharset);
  1873.  
  1874.     if (this._iconURI) {
  1875.       var imageNode = appendTextNode(OPENSEARCH_NS_11, "Image",
  1876.                                      this._iconURI.spec);
  1877.       if (imageNode) {
  1878.         imageNode.setAttribute("width", "16");
  1879.         imageNode.setAttribute("height", "16");
  1880.       }
  1881.     }
  1882.  
  1883.     appendTextNode(MOZSEARCH_NS_10, "Alias", this.alias);
  1884.     appendTextNode(MOZSEARCH_NS_10, "UpdateInterval", this._updateInterval);
  1885.     appendTextNode(MOZSEARCH_NS_10, "UpdateUrl", this._updateURL);
  1886.     appendTextNode(MOZSEARCH_NS_10, "IconUpdateUrl", this._iconUpdateURL);
  1887.     appendTextNode(MOZSEARCH_NS_10, "SearchForm", this._searchForm);
  1888.  
  1889.     for (var i = 0; i < this._urls.length; ++i)
  1890.       this._urls[i]._serializeToElement(doc, docElem);
  1891.     docElem.appendChild(doc.createTextNode("\n"));
  1892.  
  1893.     return doc;
  1894.   },
  1895.  
  1896.   /**
  1897.    * Serializes the engine object to file.
  1898.    */
  1899.   _serializeToFile: function SRCH_ENG_serializeToFile() {
  1900.     var file = this._file;
  1901.     ENSURE_WARN(!this._readOnly, "Can't serialize a read only engine!",
  1902.                 Cr.NS_ERROR_FAILURE);
  1903.     ENSURE_WARN(file && file.exists(), "Can't serialize: file doesn't exist!",
  1904.                 Cr.NS_ERROR_UNEXPECTED);
  1905.  
  1906.     var fos = Cc["@mozilla.org/network/safe-file-output-stream;1"].
  1907.               createInstance(Ci.nsIFileOutputStream);
  1908.  
  1909.     // Serialize the engine first - we don't want to overwrite a good file
  1910.     // if this somehow fails.
  1911.     doc = this._serializeToElement();
  1912.  
  1913.     fos.init(file, (MODE_WRONLY | MODE_TRUNCATE), PERMS_FILE, 0);
  1914.  
  1915.     try {
  1916.       var serializer = Cc["@mozilla.org/xmlextras/xmlserializer;1"].
  1917.                        createInstance(Ci.nsIDOMSerializer);
  1918.       serializer.serializeToStream(doc.documentElement, fos, null);
  1919.     } catch (e) {
  1920.       LOG("_serializeToFile: Error serializing engine:\n" + e);
  1921.     }
  1922.  
  1923.     closeSafeOutputStream(fos);
  1924.   },
  1925.  
  1926.   /**
  1927.    * Remove the engine's file from disk. The search service calls this once it
  1928.    * removes the engine from its internal store. This function will throw if
  1929.    * the file cannot be removed.
  1930.    */
  1931.   _remove: function SRCH_ENG_remove() {
  1932.     ENSURE(!this._readOnly, "Can't remove read only engine!",
  1933.            Cr.NS_ERROR_FAILURE);
  1934.     ENSURE(this._file && this._file.exists(),
  1935.            "Can't remove engine: file doesn't exist!",
  1936.            Cr.NS_ERROR_FILE_NOT_FOUND);
  1937.  
  1938.     this._file.remove(false);
  1939.   },
  1940.  
  1941.   // nsISearchEngine
  1942.   get alias() {
  1943.     if (this._alias === null)
  1944.       this._alias = engineMetadataService.getAttr(this, "alias");
  1945.  
  1946.     return this._alias;
  1947.   },
  1948.   set alias(val) {
  1949.     this._alias = val;
  1950.     engineMetadataService.setAttr(this, "alias", val);
  1951.     notifyAction(this, SEARCH_ENGINE_CHANGED);
  1952.   },
  1953.  
  1954.   get description() {
  1955.     return this._description;
  1956.   },
  1957.  
  1958.   get hidden() {
  1959.     if (this._hidden === null)
  1960.       this._hidden = engineMetadataService.getAttr(this, "hidden");
  1961.     return this._hidden;
  1962.   },
  1963.   set hidden(val) {
  1964.     var value = !!val;
  1965.     if (value != this._hidden) {
  1966.       this._hidden = value;
  1967.       engineMetadataService.setAttr(this, "hidden", value);
  1968.       notifyAction(this, SEARCH_ENGINE_CHANGED);
  1969.     }
  1970.   },
  1971.  
  1972.   get iconURI() {
  1973.     return this._iconURI;
  1974.   },
  1975.  
  1976.   get _iconURL() {
  1977.     if (!this._iconURI)
  1978.       return "";
  1979.     return this._iconURI.spec;
  1980.   },
  1981.  
  1982.   // Where the engine is being loaded from: will return the URI's spec if the
  1983.   // engine is being downloaded and does not yet have a file. This is only used
  1984.   // for logging.
  1985.   get _location() {
  1986.     if (this._file)
  1987.       return this._file.path;
  1988.  
  1989.     if (this._uri)
  1990.       return this._uri.spec;
  1991.  
  1992.     return "";
  1993.   },
  1994.  
  1995.   // The file that the plugin is loaded from is a unique identifier for it.  We
  1996.   // use this as the identifier to store data in the sqlite database
  1997.   get _id() {
  1998.     ENSURE_WARN(this._file, "No _file for id!", Cr.NS_ERROR_FAILURE);
  1999.  
  2000.     if (this._file.parent.equals(getDir(NS_APP_USER_SEARCH_DIR)))
  2001.       return "[profile]/" + this._file.leafName;
  2002.  
  2003.     if (this._isInAppDir)
  2004.       return "[app]/" + this._file.leafName;
  2005.  
  2006.     // We're not in the profile or appdir, so this must be an extension-shipped
  2007.     // plugin. Use the full path.
  2008.     return this._file.path;
  2009.   },
  2010.  
  2011.   get _isInAppDir() {
  2012.     ENSURE_WARN(this._file && this._file.exists(),
  2013.                 "_isInAppDir: engine has no file!",
  2014.                 Cr.NS_ERROR_FAILURE);
  2015.     if (this.__isInAppDir === null)
  2016.       this.__isInAppDir = this._file.parent.equals(getDir(NS_APP_SEARCH_DIR));
  2017.     return this.__isInAppDir;
  2018.   },
  2019.  
  2020.   get _hasUpdates() {
  2021.     // Whether or not the engine has an update URL
  2022.     return !!(this._updateURL || this._iconUpdateURL);
  2023.   },
  2024.  
  2025.   get name() {
  2026.     return this._name;
  2027.   },
  2028.  
  2029.   get type() {
  2030.     return this._type;
  2031.   },
  2032.  
  2033.   get searchForm() {
  2034.     if (!this._searchForm) {
  2035.       // No searchForm specified in the engine definition file, use the prePath
  2036.       // (e.g. https://foo.com for https://foo.com/search.php?q=bar).
  2037.       var htmlUrl = this._getURLOfType(URLTYPE_SEARCH_HTML);
  2038.       ENSURE_WARN(htmlUrl, "Engine has no HTML URL!", Cr.NS_ERROR_UNEXPECTED);
  2039.       this._searchForm = makeURI(htmlUrl.template).prePath;
  2040.     }
  2041.  
  2042.     return this._searchForm;
  2043.   },
  2044.  
  2045.   get queryCharset() {
  2046.     if (this._queryCharset)
  2047.       return this._queryCharset;
  2048.     return this._queryCharset = queryCharsetFromCode(/* get the default */);
  2049.   },
  2050.  
  2051.   // from nsISearchEngine
  2052.   addParam: function SRCH_ENG_addParam(aName, aValue, aResponseType) {
  2053.     ENSURE_ARG(aName && (aValue != null),
  2054.                "missing name or value for nsISearchEngine::addParam!");
  2055.     ENSURE_WARN(!this._readOnly,
  2056.                 "called nsISearchEngine::addParam on a read-only engine!",
  2057.                 Cr.NS_ERROR_FAILURE);
  2058.     if (!aResponseType)
  2059.       aResponseType = URLTYPE_SEARCH_HTML;
  2060.  
  2061.     var url = this._getURLOfType(aResponseType);
  2062.  
  2063.     ENSURE(url, "Engine object has no URL for response type " + aResponseType,
  2064.            Cr.NS_ERROR_FAILURE);
  2065.  
  2066.     url.addParam(aName, aValue);
  2067.   },
  2068.  
  2069.   // from nsISearchEngine
  2070.   getSubmission: function SRCH_ENG_getSubmission(aData, aResponseType) {
  2071.     if (!aResponseType)
  2072.       aResponseType = URLTYPE_SEARCH_HTML;
  2073.  
  2074.     var url = this._getURLOfType(aResponseType);
  2075.  
  2076.     if (!url)
  2077.       return null;
  2078.  
  2079.     if (!aData) {
  2080.       // Return a dummy submission object with our searchForm attribute
  2081.       return new Submission(makeURI(this.searchForm), null);
  2082.     }
  2083.  
  2084.     LOG("getSubmission: In data: \"" + aData + "\"");
  2085.     var textToSubURI = Cc["@mozilla.org/intl/texttosuburi;1"].
  2086.                        getService(Ci.nsITextToSubURI);
  2087.     var data = "";
  2088.     try {
  2089.       data = textToSubURI.ConvertAndEscape(this.queryCharset, aData);
  2090.     } catch (ex) {
  2091.       LOG("getSubmission: Falling back to default queryCharset!");
  2092.       data = textToSubURI.ConvertAndEscape(DEFAULT_QUERY_CHARSET, aData);
  2093.     }
  2094.     LOG("getSubmission: Out data: \"" + data + "\"");
  2095.     return url.getSubmission(data, this);
  2096.   },
  2097.  
  2098.   // from nsISearchEngine
  2099.   supportsResponseType: function SRCH_ENG_supportsResponseType(type) {
  2100.     return (this._getURLOfType(type) != null);
  2101.   },
  2102.  
  2103.   // nsISupports
  2104.   QueryInterface: function SRCH_ENG_QI(aIID) {
  2105.     if (aIID.equals(Ci.nsISearchEngine) ||
  2106.         aIID.equals(Ci.nsISupports))
  2107.       return this;
  2108.     throw Cr.NS_ERROR_NO_INTERFACE;
  2109.   },
  2110.  
  2111.   get wrappedJSObject() {
  2112.     return this;
  2113.   }
  2114.  
  2115. };
  2116.  
  2117. // nsISearchSubmission
  2118. function Submission(aURI, aPostData) {
  2119.   this._uri = aURI;
  2120.   this._postData = aPostData;
  2121. }
  2122. Submission.prototype = {
  2123.   get uri() {
  2124.     return this._uri;
  2125.   },
  2126.   get postData() {
  2127.     return this._postData;
  2128.   },
  2129.   QueryInterface: function SRCH_SUBM_QI(aIID) {
  2130.     if (aIID.equals(Ci.nsISearchSubmission) ||
  2131.         aIID.equals(Ci.nsISupports))
  2132.       return this;
  2133.     throw Cr.NS_ERROR_NO_INTERFACE;
  2134.   }
  2135. }
  2136.  
  2137. // nsIBrowserSearchService
  2138. function SearchService() {
  2139.   this._init();
  2140. }
  2141. SearchService.prototype = {
  2142.   _engines: { },
  2143.   _sortedEngines: null,
  2144.   // Whether or not we need to write the order of engines on shutdown. This
  2145.   // needs to happen anytime _sortedEngines is modified after initial startup. 
  2146.   _needToSetOrderPrefs: false,
  2147.  
  2148.   _init: function() {
  2149.     engineMetadataService.init();
  2150.     engineUpdateService.init();
  2151.  
  2152.     this._addObservers();
  2153.  
  2154.     var fileLocator = Cc["@mozilla.org/file/directory_service;1"].
  2155.                       getService(Ci.nsIProperties);
  2156.     var locations = fileLocator.get(NS_APP_SEARCH_DIR_LIST,
  2157.                                     Ci.nsISimpleEnumerator);
  2158.  
  2159.     while (locations.hasMoreElements()) {
  2160.       var location = locations.getNext().QueryInterface(Ci.nsIFile);
  2161.       this._loadEngines(location);
  2162.     }
  2163.  
  2164.     // Now that all engines are loaded, build the sorted engine list
  2165.     this._buildSortedEngineList();
  2166.  
  2167.     selectedEngineName = getLocalizedPref(BROWSER_SEARCH_PREF +
  2168.                                           "selectedEngine");
  2169.     this._currentEngine = this.getEngineByName(selectedEngineName) ||
  2170.                           this.defaultEngine;
  2171.   },
  2172.  
  2173.   _addEngineToStore: function SRCH_SVC_addEngineToStore(aEngine) {
  2174.     LOG("_addEngineToStore: Adding engine: \"" + aEngine.name + "\"");
  2175.  
  2176.     // See if there is an existing engine with the same name. However, if this
  2177.     // engine is updating another engine, it's allowed to have the same name.
  2178.     var hasSameNameAsUpdate = (aEngine._engineToUpdate &&
  2179.                                aEngine.name == aEngine._engineToUpdate.name);
  2180.     if (aEngine.name in this._engines && !hasSameNameAsUpdate) {
  2181.       LOG("_addEngineToStore: Duplicate engine found, aborting!");
  2182.       return;
  2183.     }
  2184.  
  2185.     if (aEngine._engineToUpdate) {
  2186.       // We need to replace engineToUpdate with the engine that just loaded.
  2187.       var oldEngine = aEngine._engineToUpdate;
  2188.  
  2189.       // Remove the old engine from the hash, since it's keyed by name, and our
  2190.       // name might change (the update might have a new name).
  2191.       delete this._engines[oldEngine.name];
  2192.  
  2193.       // Hack: we want to replace the old engine with the new one, but since
  2194.       // people may be holding refs to the nsISearchEngine objects themselves,
  2195.       // we'll just copy over all "private" properties (those without a getter
  2196.       // or setter) from one object to the other.
  2197.       for (var p in aEngine) {
  2198.         if (!(aEngine.__lookupGetter__(p) || aEngine.__lookupSetter__(p)))
  2199.           oldEngine[p] = aEngine[p];
  2200.       }
  2201.       aEngine = oldEngine;
  2202.       aEngine._engineToUpdate = null;
  2203.  
  2204.       // Add the engine back
  2205.       this._engines[aEngine.name] = aEngine;
  2206.       notifyAction(aEngine, SEARCH_ENGINE_CHANGED);
  2207.     } else {
  2208.       // Not an update, just add the new engine.
  2209.       this._engines[aEngine.name] = aEngine;
  2210.       // Only add the engine to the list of sorted engines if the initial list
  2211.       // has already been built (i.e. if this._sortedEngines is non-null). If
  2212.       // it hasn't, we're still loading engines from disk, and will build the
  2213.       // sorted engine list when that initial loading is done.
  2214.       if (this._sortedEngines) {
  2215.         this._sortedEngines.push(aEngine);
  2216.         this._needToSetOrderPrefs = true;
  2217.       }
  2218.       notifyAction(aEngine, SEARCH_ENGINE_ADDED);
  2219.     }
  2220.  
  2221.     if (aEngine._hasUpdates) {
  2222.       // Schedule the engine's next update, if it isn't already.
  2223.       if (!engineMetadataService.getAttr(aEngine, "updateexpir"))
  2224.         engineUpdateService.scheduleNextUpdate(aEngine);
  2225.   
  2226.       // We need to save the engine's _dataType, if this is the first time the
  2227.       // engine is added to the dataStore, since ._dataType isn't persisted
  2228.       // and will change on the next startup (since the engine will then be
  2229.       // XML). We need this so that we know how to load any future updates from
  2230.       // this engine.
  2231.       if (!engineMetadataService.getAttr(aEngine, "updatedatatype"))
  2232.         engineMetadataService.setAttr(aEngine, "updatedatatype",
  2233.                                       aEngine._dataType);
  2234.     }
  2235.   },
  2236.  
  2237.   _loadEngines: function SRCH_SVC_loadEngines(aDir) {
  2238.     LOG("_loadEngines: Searching in " + aDir.path + " for search engines.");
  2239.  
  2240.     // Check whether aDir is the user profile dir
  2241.     var isInProfile = aDir.equals(getDir(NS_APP_USER_SEARCH_DIR));
  2242.  
  2243.     var files = aDir.directoryEntries
  2244.                     .QueryInterface(Ci.nsIDirectoryEnumerator);
  2245.     var ios = Cc["@mozilla.org/network/io-service;1"].
  2246.               getService(Ci.nsIIOService);
  2247.  
  2248.     while (files.hasMoreElements()) {
  2249.       var file = files.nextFile;
  2250.  
  2251.       // Ignore hidden and empty files, and directories
  2252.       if (!file.isFile() || file.fileSize == 0 || file.isHidden())
  2253.         continue;
  2254.  
  2255.       var fileURL = ios.newFileURI(file).QueryInterface(Ci.nsIURL);
  2256.       var fileExtension = fileURL.fileExtension.toLowerCase();
  2257.       var isWritable = isInProfile && file.isWritable();
  2258.  
  2259.       var dataType;
  2260.       switch (fileExtension) {
  2261.         case XML_FILE_EXT:
  2262.           dataType = SEARCH_DATA_XML;
  2263.           break;
  2264.         case SHERLOCK_FILE_EXT:
  2265.           dataType = SEARCH_DATA_TEXT;
  2266.           break;
  2267.         default:
  2268.           // Not an engine
  2269.           continue;
  2270.       }
  2271.  
  2272.       var addedEngine = null;
  2273.       try {
  2274.         addedEngine = new Engine(file, dataType, !isWritable);
  2275.         addedEngine._initFromFile();
  2276.       } catch (ex) {
  2277.         LOG("_loadEngines: Failed to load " + file.path + "!\n" + ex);
  2278.         continue;
  2279.       }
  2280.  
  2281.       if (fileExtension == SHERLOCK_FILE_EXT) {
  2282.         if (isWritable) {
  2283.           try {
  2284.             this._convertSherlockFile(addedEngine, fileURL.fileBaseName);
  2285.           } catch (ex) {
  2286.             LOG("_loadEngines: Failed to convert: " + fileURL.path + "\n" + ex);
  2287.             // The engine couldn't be converted, mark it as read-only
  2288.             addedEngine._readOnly = true;
  2289.           }
  2290.         }
  2291.  
  2292.         // If the engine still doesn't have an icon, see if we can find one
  2293.         if (!addedEngine._iconURI) {
  2294.           var icon = this._findSherlockIcon(file, fileURL.fileBaseName);
  2295.           if (icon)
  2296.             addedEngine._iconURI = ios.newFileURI(icon);
  2297.         }
  2298.       }
  2299.  
  2300.       this._addEngineToStore(addedEngine);
  2301.     }
  2302.   },
  2303.  
  2304.   _saveSortedEngineList: function SRCH_SVC_saveSortedEngineList() {
  2305.     // We only need to write the prefs. if something has changed.
  2306.     if (!this._needToSetOrderPrefs)
  2307.       return;
  2308.  
  2309.     // Set the useDB pref to indicate that from now on we should use the order
  2310.     // information stored in the database.
  2311.     var prefB = Cc["@mozilla.org/preferences-service;1"].
  2312.                 getService(Ci.nsIPrefBranch);
  2313.     prefB.setBoolPref(BROWSER_SEARCH_PREF + "useDBForOrder", true);
  2314.  
  2315.     var engines = this._getSortedEngines(true);
  2316.     var values = [];
  2317.     var names = [];
  2318.  
  2319.     for (var i = 0; i < engines.length; ++i) {
  2320.       names[i] = "order";
  2321.       values[i] = i + 1;
  2322.     }
  2323.  
  2324.     engineMetadataService.setAttrs(engines, names, values);
  2325.   },
  2326.  
  2327.   _buildSortedEngineList: function SRCH_SVC_buildSortedEngineList() {
  2328.     var addedEngines = { };
  2329.     this._sortedEngines = [];
  2330.     var engine;
  2331.  
  2332.     // If the user has specified a custom engine order, read the order
  2333.     // information from the engineMetadataService instead of the default
  2334.     // prefs.
  2335.     if (getBoolPref(BROWSER_SEARCH_PREF + "useDBForOrder", false)) {
  2336.       for each (engine in this._engines) {
  2337.         var orderNumber = engineMetadataService.getAttr(engine, "order");
  2338.  
  2339.         // Since the DB isn't regularly cleared, and engine files may disappear
  2340.         // without us knowing, we may already have an engine in this slot. If
  2341.         // that happens, we just skip it - it will be added later on as an
  2342.         // unsorted engine. This problem will sort itself out when we call
  2343.         // _saveSortedEngineList at shutdown.
  2344.         if (orderNumber && !this._sortedEngines[orderNumber-1]) {
  2345.           this._sortedEngines[orderNumber-1] = engine;
  2346.           addedEngines[engine.name] = engine;
  2347.         } else {
  2348.           // We need to call _saveSortedEngines so this gets sorted out.
  2349.           this._needToSetOrderPrefs = true;
  2350.         }
  2351.       }
  2352.  
  2353.       // Filter out any nulls for engines that may have been removed
  2354.       var filteredEngines = this._sortedEngines.filter(function(a) { return !!a; });
  2355.       if (this._sortedEngines.length != filteredEngines.length)
  2356.         this._needToSetOrderPrefs = true;
  2357.       this._sortedEngines = filteredEngines;
  2358.  
  2359.     } else {
  2360.       // The DB isn't being used, so just read the engine order from the prefs
  2361.       var i = 0;
  2362.       var engineName;
  2363.       var prefName;
  2364.  
  2365.       try {
  2366.         var prefB = Cc["@mozilla.org/preferences-service;1"].
  2367.                     getService(Ci.nsIPrefBranch);
  2368.         var extras =
  2369.           prefB.getChildList(BROWSER_SEARCH_PREF + "order.extra.", { });
  2370.  
  2371.         for each (prefName in extras) {
  2372.           engineName = prefB.getCharPref(prefName);
  2373.  
  2374.           engine = this._engines[engineName];
  2375.           if (!engine || engine.name in addedEngines)
  2376.             continue;
  2377.  
  2378.           this._sortedEngines.push(engine);
  2379.           addedEngines[engine.name] = engine;
  2380.         }
  2381.       }
  2382.       catch (e) { }
  2383.  
  2384.       while (true) {
  2385.         engineName = getLocalizedPref(BROWSER_SEARCH_PREF + "order." + (++i));
  2386.         if (!engineName)
  2387.           break;
  2388.  
  2389.         engine = this._engines[engineName];
  2390.         if (!engine || engine.name in addedEngines)
  2391.           continue;
  2392.         
  2393.         this._sortedEngines.push(engine);
  2394.         addedEngines[engine.name] = engine;
  2395.       }
  2396.     }
  2397.  
  2398.     // Array for the remaining engines, alphabetically sorted
  2399.     var alphaEngines = [];
  2400.  
  2401.     for each (engine in this._engines) {
  2402.       if (!(engine.name in addedEngines))
  2403.         alphaEngines.push(this._engines[engine.name]);
  2404.     }
  2405.     alphaEngines = alphaEngines.sort(function (a, b) {
  2406.                                        return a.name.localeCompare(b.name);
  2407.                                      });
  2408.     this._sortedEngines = this._sortedEngines.concat(alphaEngines);
  2409.   },
  2410.  
  2411.   /**
  2412.    * Converts a Sherlock file and its icon into the custom XML format used by
  2413.    * the Search Service. Saves the engine's icon (if present) into the XML as a
  2414.    * data: URI and changes the extension of the source file from ".src" to
  2415.    * ".xml". The engine data is then written to the file as XML.
  2416.    * @param aEngine
  2417.    *        The Engine object that needs to be converted.
  2418.    * @param aBaseName
  2419.    *        The basename of the Sherlock file.
  2420.    *          Example: "foo" for file "foo.src".
  2421.    *
  2422.    * @throws NS_ERROR_FAILURE if the file could not be converted.
  2423.    *
  2424.    * @see nsIURL::fileBaseName
  2425.    */
  2426.   _convertSherlockFile: function SRCH_SVC_convertSherlock(aEngine, aBaseName) {
  2427.     var oldSherlockFile = aEngine._file;
  2428.  
  2429.     // Back up the old file
  2430.     try {
  2431.       var backupDir = oldSherlockFile.parent;
  2432.       backupDir.append("searchplugins-backup");
  2433.  
  2434.       if (!backupDir.exists())
  2435.         backupDir.create(Ci.nsIFile.DIRECTORY_TYPE, PERMS_DIRECTORY);
  2436.  
  2437.       oldSherlockFile.copyTo(backupDir, null);
  2438.     } catch (ex) {
  2439.       // Just bail. Engines that can't be backed up won't be converted, but
  2440.       // engines that aren't converted are loaded as readonly.
  2441.       LOG("_convertSherlockFile: Couldn't back up " + oldSherlockFile.path +
  2442.           ":\n" + ex);
  2443.       throw Cr.NS_ERROR_FAILURE;
  2444.     }
  2445.  
  2446.     // Rename the file, but don't clobber existing files
  2447.     var newXMLFile = oldSherlockFile.parent.clone();
  2448.     newXMLFile.append(aBaseName + "." + XML_FILE_EXT);
  2449.  
  2450.     if (newXMLFile.exists()) {
  2451.       // There is an existing file with this name, create a unique file
  2452.       newXMLFile.createUnique(Ci.nsIFile.NORMAL_FILE_TYPE, PERMS_FILE);
  2453.     }
  2454.  
  2455.     aEngine._unconvertedFile = oldSherlockFile.clone();
  2456.  
  2457.     // Rename the .src file to .xml
  2458.     oldSherlockFile.moveTo(null, newXMLFile.leafName);
  2459.  
  2460.     aEngine._file = newXMLFile;
  2461.  
  2462.     // Write the converted engine to disk
  2463.     aEngine._serializeToFile();
  2464.  
  2465.     // Update the engine's _type.
  2466.     aEngine._type = SEARCH_TYPE_MOZSEARCH;
  2467.  
  2468.     // See if it has a corresponding icon
  2469.     try {
  2470.       var icon = this._findSherlockIcon(aEngine._file, aBaseName);
  2471.       if (icon && icon.fileSize < MAX_ICON_SIZE) {
  2472.         // Use this as the engine's icon
  2473.         var bStream = Cc["@mozilla.org/binaryinputstream;1"].
  2474.                         createInstance(Ci.nsIBinaryInputStream);
  2475.         var fileInStream = Cc["@mozilla.org/network/file-input-stream;1"].
  2476.                            createInstance(Ci.nsIFileInputStream);
  2477.  
  2478.         fileInStream.init(icon, MODE_RDONLY, PERMS_FILE, 0);
  2479.         bStream.setInputStream(fileInStream);
  2480.  
  2481.         var bytes = [];
  2482.         while (bStream.available() != 0)
  2483.           bytes = bytes.concat(bStream.readByteArray(bStream.available()));
  2484.         bStream.close();
  2485.  
  2486.         // Convert the byte array to a base64-encoded string
  2487.         var str = b64(bytes);
  2488.  
  2489.         aEngine._iconURI = makeURI(ICON_DATAURL_PREFIX + str);
  2490.         LOG("_importSherlockEngine: Set sherlock iconURI to: \"" +
  2491.             aEngine._iconURL + "\"");
  2492.  
  2493.         // Write the engine to disk to save changes
  2494.         aEngine._serializeToFile();
  2495.  
  2496.         // Delete the icon now that we're sure everything's been saved
  2497.         icon.remove(false);
  2498.       }
  2499.     } catch (ex) { LOG("_convertSherlockFile: Error setting icon:\n" + ex); }
  2500.   },
  2501.  
  2502.   /**
  2503.    * Finds an icon associated to a given Sherlock file. Searches the provided
  2504.    * file's parent directory looking for files with the same base name and one
  2505.    * of the file extensions in SHERLOCK_ICON_EXTENSIONS.
  2506.    * @param aEngineFile
  2507.    *        The Sherlock plugin file.
  2508.    * @param aBaseName
  2509.    *        The basename of the Sherlock file.
  2510.    *          Example: "foo" for file "foo.src".
  2511.    * @see nsIURL::fileBaseName
  2512.    */
  2513.   _findSherlockIcon: function SRCH_SVC_findSherlock(aEngineFile, aBaseName) {
  2514.     for (var i = 0; i < SHERLOCK_ICON_EXTENSIONS.length; i++) {
  2515.       var icon = aEngineFile.parent.clone();
  2516.       icon.append(aBaseName + SHERLOCK_ICON_EXTENSIONS[i]);
  2517.       if (icon.exists() && icon.isFile())
  2518.         return icon;
  2519.     }
  2520.     return null;
  2521.   },
  2522.  
  2523.   /**
  2524.    * Get a sorted array of engines.
  2525.    * @param aWithHidden
  2526.    *        True if hidden plugins should be included in the result.
  2527.    */
  2528.   _getSortedEngines: function SRCH_SVC_getSorted(aWithHidden) {
  2529.     if (aWithHidden)
  2530.       return this._sortedEngines;
  2531.  
  2532.     return this._sortedEngines.filter(function (engine) {
  2533.                                         return !engine.hidden;
  2534.                                       });
  2535.   },
  2536.  
  2537.   // nsIBrowserSearchService
  2538.   getEngines: function SRCH_SVC_getEngines(aCount) {
  2539.     LOG("getEngines: getting all engines");
  2540.     var engines = this._getSortedEngines(true);
  2541.     aCount.value = engines.length;
  2542.     return engines;
  2543.   },
  2544.  
  2545.   getVisibleEngines: function SRCH_SVC_getVisible(aCount) {
  2546.     LOG("getVisibleEngines: getting all visible engines");
  2547.     var engines = this._getSortedEngines(false);
  2548.     aCount.value = engines.length;
  2549.     return engines;
  2550.   },
  2551.  
  2552.   getDefaultEngines: function SRCH_SVC_getDefault(aCount) {
  2553.     function isDefault (engine) {
  2554.       return engine._isInAppDir;
  2555.     };
  2556.     var engines = this._sortedEngines.filter(isDefault);
  2557.     var engineOrder = {};
  2558.     var i = 1;
  2559.  
  2560.     while (true) {
  2561.       var name = getLocalizedPref(BROWSER_SEARCH_PREF + "order." + i);
  2562.       if (!name)
  2563.         break;
  2564.  
  2565.       engineOrder[name] = i++;
  2566.     }
  2567.  
  2568.     function compareEngines (a, b) {
  2569.       var aIdx = engineOrder[a.name];
  2570.       var bIdx = engineOrder[b.name];
  2571.  
  2572.       if (aIdx && bIdx)
  2573.         return aIdx - bIdx;
  2574.       if (aIdx)
  2575.         return -1;
  2576.       if (bIdx)
  2577.         return 1;
  2578.  
  2579.       return a.name.localeCompare(b.name);
  2580.     }
  2581.     engines.sort(compareEngines);
  2582.  
  2583.     aCount.value = engines.length;
  2584.     return engines;
  2585.   },
  2586.  
  2587.   getEngineByName: function SRCH_SVC_getEngineByName(aEngineName) {
  2588.     return this._engines[aEngineName] || null;
  2589.   },
  2590.  
  2591.   getEngineByAlias: function SRCH_SVC_getEngineByAlias(aAlias) {
  2592.     for (var engineName in this._engines) {
  2593.       var engine = this._engines[engineName];
  2594.       if (engine && engine.alias == aAlias)
  2595.         return engine;
  2596.     }
  2597.     return null;
  2598.   },
  2599.  
  2600.   addEngineWithDetails: function SRCH_SVC_addEWD(aName, aIconURL, aAlias,
  2601.                                                  aDescription, aMethod,
  2602.                                                  aTemplate) {
  2603.     ENSURE_ARG(aName, "Invalid name passed to addEngineWithDetails!");
  2604.     ENSURE_ARG(aMethod, "Invalid method passed to addEngineWithDetails!");
  2605.     ENSURE_ARG(aTemplate, "Invalid template passed to addEngineWithDetails!");
  2606.  
  2607.     ENSURE(!this._engines[aName], "An engine with that name already exists!",
  2608.            Cr.NS_ERROR_FILE_ALREADY_EXISTS);
  2609.  
  2610.     var engine = new Engine(getSanitizedFile(aName), SEARCH_DATA_XML, false);
  2611.     engine._initFromMetadata(aName, aIconURL, aAlias, aDescription,
  2612.                              aMethod, aTemplate);
  2613.     this._addEngineToStore(engine);
  2614.   },
  2615.  
  2616.   addEngine: function SRCH_SVC_addEngine(aEngineURL, aDataType, aIconURL,
  2617.                                          aConfirm) {
  2618.     LOG("addEngine: Adding \"" + aEngineURL + "\".");
  2619.     try {
  2620.       var uri = makeURI(aEngineURL);
  2621.       var engine = new Engine(uri, aDataType, false);
  2622.       engine._initFromURI();
  2623.     } catch (ex) {
  2624.       LOG("addEngine: Error adding engine:\n" + ex);
  2625.       throw Cr.NS_ERROR_FAILURE;
  2626.     }
  2627.     engine._setIcon(aIconURL, false);
  2628.     engine._confirm = aConfirm;
  2629.   },
  2630.  
  2631.   removeEngine: function SRCH_SVC_removeEngine(aEngine) {
  2632.     ENSURE_ARG(aEngine, "no engine passed to removeEngine!");
  2633.  
  2634.     var engineToRemove = null;
  2635.     for (var e in this._engines)
  2636.       if (aEngine.wrappedJSObject == this._engines[e])
  2637.         engineToRemove = this._engines[e];
  2638.  
  2639.     ENSURE(engineToRemove, "removeEngine: Can't find engine to remove!",
  2640.            Cr.NS_ERROR_FILE_NOT_FOUND);
  2641.  
  2642.     if (engineToRemove == this.currentEngine)
  2643.       this._currentEngine = null;
  2644.  
  2645.     if (engineToRemove._readOnly) {
  2646.       // Just hide it (the "hidden" setter will notify)
  2647.       engineToRemove.hidden = true;
  2648.     } else {
  2649.       // Remove the engine file from disk (this might throw)
  2650.       engineToRemove._remove();
  2651.       engineToRemove._file = null;
  2652.  
  2653.       // Remove the engine from _sortedEngines
  2654.       var index = this._sortedEngines.indexOf(engineToRemove);
  2655.       ENSURE(index != -1, "Can't find engine to remove in _sortedEngines!",
  2656.              Cr.NS_ERROR_FAILURE);
  2657.       this._sortedEngines.splice(index, 1);
  2658.  
  2659.       // Remove the engine from the internal store
  2660.       delete this._engines[engineToRemove.name];
  2661.  
  2662.       notifyAction(engineToRemove, SEARCH_ENGINE_REMOVED);
  2663.  
  2664.       // Since we removed an engine, we need to update the preferences.
  2665.       this._needToSetOrderPrefs = true;
  2666.     }
  2667.   },
  2668.  
  2669.   moveEngine: function SRCH_SVC_moveEngine(aEngine, aNewIndex) {
  2670.     ENSURE_ARG((aNewIndex < this._sortedEngines.length) && (aNewIndex >= 0),
  2671.                "SRCH_SVC_moveEngine: Index out of bounds!");
  2672.     ENSURE_ARG(aEngine instanceof Ci.nsISearchEngine,
  2673.                "SRCH_SVC_moveEngine: Invalid engine passed to moveEngine!");
  2674.     ENSURE(!aEngine.hidden, "moveEngine: Can't move a hidden engine!",
  2675.            Cr.NS_ERROR_FAILURE);
  2676.  
  2677.     var engine = aEngine.wrappedJSObject;
  2678.  
  2679.     var currentIndex = this._sortedEngines.indexOf(engine);
  2680.     ENSURE(currentIndex != -1, "moveEngine: Can't find engine to move!",
  2681.            Cr.NS_ERROR_UNEXPECTED);
  2682.  
  2683.     // Our callers only take into account non-hidden engines when calculating
  2684.     // aNewIndex, but we need to move it in the array of all engines, so we
  2685.     // need to adjust aNewIndex accordingly. To do this, we count the number
  2686.     // of hidden engines in the list before the engine that we're taking the
  2687.     // place of. We do this by first finding newIndexEngine (the engine that
  2688.     // we were supposed to replace) and then iterating through the complete 
  2689.     // engine list until we reach it, increasing aNewIndex for each hidden
  2690.     // engine we find on our way there.
  2691.     //
  2692.     // This could be further simplified by having our caller pass in
  2693.     // newIndexEngine directly instead of aNewIndex.
  2694.     var newIndexEngine = this._getSortedEngines(false)[aNewIndex];
  2695.     ENSURE(newIndexEngine, "moveEngine: Can't find engine to replace!",
  2696.            Cr.NS_ERROR_UNEXPECTED);
  2697.  
  2698.     for (var i = 0; i < this._sortedEngines.length; ++i) {
  2699.       if (newIndexEngine == this._sortedEngines[i])
  2700.         break;
  2701.       if (this._sortedEngines[i].hidden)
  2702.         aNewIndex++;
  2703.     }
  2704.  
  2705.     if (currentIndex == aNewIndex)
  2706.       return; // nothing to do!
  2707.  
  2708.     // Move the engine
  2709.     var movedEngine = this._sortedEngines.splice(currentIndex, 1)[0];
  2710.     this._sortedEngines.splice(aNewIndex, 0, movedEngine);
  2711.  
  2712.     notifyAction(engine, SEARCH_ENGINE_CHANGED);
  2713.  
  2714.     // Since we moved an engine, we need to update the preferences.
  2715.     this._needToSetOrderPrefs = true;
  2716.   },
  2717.  
  2718.   restoreDefaultEngines: function SRCH_SVC_resetDefaultEngines() {
  2719.     for each (var e in this._engines) {
  2720.       // Unhide all appdir-installed engines
  2721.       if (e.hidden && e._isInAppDir)
  2722.         e.hidden = false;
  2723.     }
  2724.   },
  2725.  
  2726.   get defaultEngine() {
  2727.     const defPref = BROWSER_SEARCH_PREF + "defaultenginename";
  2728.     // Get the default engine - this pref should always exist, but the engine
  2729.     // might be hidden
  2730.     this._defaultEngine = this.getEngineByName(getLocalizedPref(defPref, ""));
  2731.     if (!this._defaultEngine || this._defaultEngine.hidden)
  2732.       this._defaultEngine = this._getSortedEngines(false)[0] || null;
  2733.     return this._defaultEngine;
  2734.   },
  2735.  
  2736.   get currentEngine() {
  2737.     if (!this._currentEngine || this._currentEngine.hidden)
  2738.       this._currentEngine = this.defaultEngine;
  2739.     return this._currentEngine;
  2740.   },
  2741.   set currentEngine(val) {
  2742.     ENSURE_ARG(val instanceof Ci.nsISearchEngine,
  2743.                "Invalid argument passed to currentEngine setter");
  2744.  
  2745.     var newCurrentEngine = this.getEngineByName(val.name);
  2746.     ENSURE(newCurrentEngine, "Can't find engine in store!",
  2747.            Cr.NS_ERROR_UNEXPECTED);
  2748.  
  2749.     this._currentEngine = newCurrentEngine;
  2750.  
  2751.     var currentEnginePref = BROWSER_SEARCH_PREF + "selectedEngine";
  2752.  
  2753.     var prefB = Cc["@mozilla.org/preferences-service;1"].
  2754.       getService(Ci.nsIPrefService).QueryInterface(Ci.nsIPrefBranch);
  2755.  
  2756.     if (this._currentEngine == this.defaultEngine) {
  2757.       if (prefB.prefHasUserValue(currentEnginePref))
  2758.         prefB.clearUserPref(currentEnginePref);
  2759.     }
  2760.     else {
  2761.       setLocalizedPref(currentEnginePref, this._currentEngine.name);
  2762.     }
  2763.  
  2764.     notifyAction(this._currentEngine, SEARCH_ENGINE_CURRENT);
  2765.   },
  2766.  
  2767.   // nsIObserver
  2768.   observe: function SRCH_SVC_observe(aEngine, aTopic, aVerb) {
  2769.     switch (aTopic) {
  2770.       case SEARCH_ENGINE_TOPIC:
  2771.         if (aVerb == SEARCH_ENGINE_LOADED) {
  2772.           var engine = aEngine.QueryInterface(Ci.nsISearchEngine);
  2773.           LOG("nsSearchService::observe: Done installation of " + engine.name
  2774.               + ".");
  2775.           this._addEngineToStore(engine.wrappedJSObject);
  2776.           if (engine.wrappedJSObject._useNow) {
  2777.             LOG("nsSearchService::observe: setting current");
  2778.             this.currentEngine = aEngine;
  2779.           }
  2780.         }
  2781.         break;
  2782.       case QUIT_APPLICATION_TOPIC:
  2783.         this._removeObservers();
  2784.         this._saveSortedEngineList();
  2785.         break;
  2786.     }
  2787.   },
  2788.  
  2789.   _addObservers: function SRCH_SVC_addObservers() {
  2790.     var os = Cc["@mozilla.org/observer-service;1"].
  2791.              getService(Ci.nsIObserverService);
  2792.     os.addObserver(this, SEARCH_ENGINE_TOPIC, false);
  2793.     os.addObserver(this, QUIT_APPLICATION_TOPIC, false);
  2794.   },
  2795.  
  2796.   _removeObservers: function SRCH_SVC_removeObservers() {
  2797.     var os = Cc["@mozilla.org/observer-service;1"].
  2798.              getService(Ci.nsIObserverService);
  2799.     os.removeObserver(this, SEARCH_ENGINE_TOPIC);
  2800.     os.removeObserver(this, QUIT_APPLICATION_TOPIC);
  2801.   },
  2802.  
  2803.   QueryInterface: function SRCH_SVC_QI(aIID) {
  2804.     if (aIID.equals(Ci.nsIBrowserSearchService) ||
  2805.         aIID.equals(Ci.nsIObserver)             ||
  2806.         aIID.equals(Ci.nsISupports))
  2807.       return this;
  2808.     throw Cr.NS_ERROR_NO_INTERFACE;
  2809.   }
  2810. };
  2811.  
  2812. var engineMetadataService = {
  2813.   init: function epsInit() {
  2814.     var engineDataTable = "id INTEGER PRIMARY KEY, engineid STRING, name STRING, value STRING";
  2815.     var file = getDir(NS_APP_USER_PROFILE_50_DIR);
  2816.     file.append("search.sqlite");
  2817.     var dbService = Cc["@mozilla.org/storage/service;1"].
  2818.                     getService(Ci.mozIStorageService);
  2819.     this.mDB = dbService.openDatabase(file);
  2820.  
  2821.     try {
  2822.       this.mDB.createTable("engine_data", engineDataTable);
  2823.     } catch (ex) {
  2824.       // Fails if the table already exists, which is fine
  2825.     }
  2826.  
  2827.     this.mGetData = createStatement (
  2828.       this.mDB,
  2829.       "SELECT value FROM engine_data WHERE engineid = :engineid AND name = :name");
  2830.     this.mDeleteData = createStatement (
  2831.       this.mDB,
  2832.       "DELETE FROM engine_data WHERE engineid = :engineid AND name = :name");
  2833.     this.mInsertData = createStatement (
  2834.       this.mDB,
  2835.       "INSERT INTO engine_data (engineid, name, value) " +
  2836.       "VALUES (:engineid, :name, :value)");
  2837.   },
  2838.   getAttr: function epsGetAttr(engine, name) {
  2839.      // attr names must be lower case
  2840.      name = name.toLowerCase();
  2841.  
  2842.     var stmt = this.mGetData;
  2843.     stmt.reset();
  2844.     var pp = stmt.params;
  2845.     pp.engineid = engine._id;
  2846.     pp.name = name;
  2847.  
  2848.     var value = null;
  2849.     if (stmt.step())
  2850.       value = stmt.row.value;
  2851.     stmt.reset();
  2852.     return value;
  2853.   },
  2854.  
  2855.   setAttr: function epsSetAttr(engine, name, value) {
  2856.     // attr names must be lower case
  2857.     name = name.toLowerCase();
  2858.  
  2859.     this.mDB.beginTransaction();
  2860.  
  2861.     var pp = this.mDeleteData.params;
  2862.     pp.engineid = engine._id;
  2863.     pp.name = name;
  2864.     this.mDeleteData.step();
  2865.     this.mDeleteData.reset();
  2866.  
  2867.     pp = this.mInsertData.params;
  2868.     pp.engineid = engine._id;
  2869.     pp.name = name;
  2870.     pp.value = value;
  2871.     this.mInsertData.step();
  2872.     this.mInsertData.reset();
  2873.  
  2874.     this.mDB.commitTransaction();
  2875.   },
  2876.  
  2877.   setAttrs: function epsSetAttrs(engines, names, values) {
  2878.     this.mDB.beginTransaction();
  2879.  
  2880.     for (var i = 0; i < engines.length; i++) {
  2881.       // attr names must be lower case
  2882.       var name = names[i].toLowerCase();
  2883.  
  2884.       var pp = this.mDeleteData.params;
  2885.       pp.engineid = engines[i]._id;
  2886.       pp.name = names[i];
  2887.       this.mDeleteData.step();
  2888.       this.mDeleteData.reset();
  2889.  
  2890.       pp = this.mInsertData.params;
  2891.       pp.engineid = engines[i]._id;
  2892.       pp.name = names[i];
  2893.       pp.value = values[i];
  2894.       this.mInsertData.step();
  2895.       this.mInsertData.reset();
  2896.     }
  2897.  
  2898.     this.mDB.commitTransaction();
  2899.   },
  2900.  
  2901.   deleteEngineData: function epsDelData(engine, name) {
  2902.     // attr names must be lower case
  2903.     name = name.toLowerCase();
  2904.  
  2905.     var pp = this.mDeleteData.params;
  2906.     pp.engineid = engine._id;
  2907.     pp.name = name;
  2908.     this.mDeleteData.step();
  2909.     this.mDeleteData.reset();
  2910.   }
  2911. }
  2912.  
  2913. const SEARCH_UPDATE_LOG_PREFIX = "*** Search update: ";
  2914.  
  2915. /**
  2916.  * Outputs aText to the JavaScript console as well as to stdout, if the search
  2917.  * logging pref (browser.search.update.log) is set to true.
  2918.  */
  2919. function ULOG(aText) {
  2920.   var prefB = Cc["@mozilla.org/preferences-service;1"].
  2921.               getService(Ci.nsIPrefBranch);
  2922.   var shouldLog = false;
  2923.   try {
  2924.     shouldLog = prefB.getBoolPref(BROWSER_SEARCH_PREF + "update.log");
  2925.   } catch (ex) {}
  2926.  
  2927.   if (shouldLog) {
  2928.     dump(SEARCH_UPDATE_LOG_PREFIX + aText + "\n");
  2929.     var consoleService = Cc["@mozilla.org/consoleservice;1"].
  2930.                          getService(Ci.nsIConsoleService);
  2931.     consoleService.logStringMessage(aText);
  2932.   }
  2933. }
  2934.  
  2935. var engineUpdateService = {
  2936.   init: function eus_init() {
  2937.     var tm = Cc["@mozilla.org/updates/timer-manager;1"].
  2938.              getService(Ci.nsIUpdateTimerManager);
  2939.     // figure out how often to check for any expired engines
  2940.     var prefB = Cc["@mozilla.org/preferences-service;1"].
  2941.                 getService(Ci.nsIPrefBranch);
  2942.     var interval = prefB.getIntPref(BROWSER_SEARCH_PREF + "updateinterval");
  2943.  
  2944.     // Interval is stored in hours
  2945.     var seconds = interval * 3600;
  2946.     tm.registerTimer("search-engine-update-timer", engineUpdateService,
  2947.                      seconds);
  2948.   },
  2949.  
  2950.   scheduleNextUpdate: function eus_scheduleNextUpdate(aEngine) {
  2951.     var interval = aEngine._updateInterval || SEARCH_DEFAULT_UPDATE_INTERVAL;
  2952.     var milliseconds = interval * 86400000; // |interval| is in days
  2953.     engineMetadataService.setAttr(aEngine, "updateexpir",
  2954.                                   Date.now() + milliseconds);
  2955.   },
  2956.  
  2957.   notify: function eus_Notify(aTimer) {
  2958.     ULOG("notify called");
  2959.  
  2960.     if (!getBoolPref(BROWSER_SEARCH_PREF + "update", true))
  2961.       return;
  2962.  
  2963.     // Our timer has expired, but unfortunately, we can't get any data from it.
  2964.     // Therefore, we need to walk our engine-list, looking for expired engines
  2965.     var searchService = Cc["@mozilla.org/browser/search-service;1"].
  2966.                         getService(Ci.nsIBrowserSearchService);
  2967.     var currentTime = Date.now();
  2968.     ULOG("currentTime: " + currentTime);
  2969.     for each (engine in searchService.getEngines({})) {
  2970.       engine = engine.wrappedJSObject;
  2971.       if (!engine._hasUpdates || engine._readOnly)
  2972.         continue;
  2973.  
  2974.       ULOG("checking " + engine.name);
  2975.  
  2976.       var expirTime = engineMetadataService.getAttr(engine, "updateexpir");
  2977.       var updateURL = engine._updateURL;
  2978.       var iconUpdateURL = engine._iconUpdateURL;
  2979.       ULOG("expirTime: " + expirTime + "\nupdateURL: " + updateURL +
  2980.            "\niconUpdateURL: " + iconUpdateURL);
  2981.  
  2982.       var engineExpired = expirTime <= currentTime;
  2983.  
  2984.       if (!expirTime || !engineExpired) {
  2985.         ULOG("skipping engine");
  2986.         continue;
  2987.       }
  2988.  
  2989.       ULOG(engine.name + " has expired");
  2990.  
  2991.       var testEngine = null;
  2992.  
  2993.       var updateURI = makeURI(updateURL);
  2994.       if (updateURI) {
  2995.         var dataType = engineMetadataService.getAttr(engine, "updatedatatype")
  2996.         if (!dataType) {
  2997.           ULOG("No loadtype to update engine!");
  2998.           continue;
  2999.         }
  3000.  
  3001.         testEngine = new Engine(updateURI, dataType, false);
  3002.         testEngine._engineToUpdate = engine;
  3003.         testEngine._initFromURI();
  3004.       } else
  3005.         ULOG("invalid updateURI");
  3006.  
  3007.       if (iconUpdateURL) {
  3008.         // If we're updating the engine too, use the new engine object,
  3009.         // otherwise use the existing engine object.
  3010.         (testEngine || engine)._setIcon(iconUpdateURL, true);
  3011.       }
  3012.  
  3013.       // Schedule the next update
  3014.       this.scheduleNextUpdate(engine);
  3015.  
  3016.     } // end engine iteration
  3017.   }
  3018. };
  3019.  
  3020. const kClassID    = Components.ID("{7319788a-fe93-4db3-9f39-818cf08f4256}");
  3021. const kClassName  = "Browser Search Service";
  3022. const kContractID = "@mozilla.org/browser/search-service;1";
  3023.  
  3024. // nsIFactory
  3025. const kFactory = {
  3026.   createInstance: function (outer, iid) {
  3027.     if (outer != null)
  3028.       throw Cr.NS_ERROR_NO_AGGREGATION;
  3029.     return (new SearchService()).QueryInterface(iid);
  3030.   }
  3031. };
  3032.  
  3033. // nsIModule
  3034. const gModule = {
  3035.   registerSelf: function (componentManager, fileSpec, location, type) {
  3036.     componentManager.QueryInterface(Ci.nsIComponentRegistrar);
  3037.     componentManager.registerFactoryLocation(kClassID,
  3038.                                              kClassName,
  3039.                                              kContractID,
  3040.                                              fileSpec, location, type);
  3041.   },
  3042.  
  3043.   unregisterSelf: function(componentManager, fileSpec, location) {
  3044.     componentManager.QueryInterface(Ci.nsIComponentRegistrar);
  3045.     componentManager.unregisterFactoryLocation(kClassID, fileSpec);
  3046.   },
  3047.  
  3048.   getClassObject: function (componentManager, cid, iid) {
  3049.     if (!cid.equals(kClassID))
  3050.       throw Cr.NS_ERROR_NO_INTERFACE;
  3051.     if (!iid.equals(Ci.nsIFactory))
  3052.       throw Cr.NS_ERROR_NOT_IMPLEMENTED;
  3053.     return kFactory;
  3054.   },
  3055.  
  3056.   canUnload: function (componentManager) {
  3057.     return true;
  3058.   }
  3059. };
  3060.  
  3061. function NSGetModule(componentManager, fileSpec) {
  3062.   return gModule;
  3063. }
  3064.  
  3065. //@line 44 "/cygdrive/K/tinderbuild/src/flock/mozilla/browser/components/search/../../../toolkit/content/debug.js"
  3066.  
  3067. var gTraceOnAssert = true;
  3068.  
  3069. /**
  3070.  * This function provides a simple assertion function for JavaScript.
  3071.  * If the condition is true, this function will do nothing.  If the
  3072.  * condition is false, then the message will be printed to the console
  3073.  * and an alert will appear showing a stack trace, so that the (alpha
  3074.  * or nightly) user can file a bug containing it.  For future enhancements, 
  3075.  * see bugs 330077 and 330078.
  3076.  *
  3077.  * To suppress the dialogs, you can run with the environment variable
  3078.  * XUL_ASSERT_PROMPT set to 0 (if unset, this defaults to 1).
  3079.  *
  3080.  * @param condition represents the condition that we're asserting to be
  3081.  *                  true when we call this function--should be
  3082.  *                  something that can be evaluated as a boolean.
  3083.  * @param message   a string to be displayed upon failure of the assertion
  3084.  */
  3085.  
  3086. function NS_ASSERT(condition, message) {
  3087.   if (condition)
  3088.     return;
  3089.  
  3090.   var assertionText = "ASSERT: " + message + "\n";
  3091.  
  3092. //@line 72 "/cygdrive/K/tinderbuild/src/flock/mozilla/browser/components/search/../../../toolkit/content/debug.js"
  3093.   Components.util.reportError(assertionText);
  3094.   return;
  3095. //@line 108 "/cygdrive/K/tinderbuild/src/flock/mozilla/browser/components/search/../../../toolkit/content/debug.js"
  3096. }
  3097.